Skip to main content
GET
/
webhook_subscriptions
Get webhook subscriptions
curl --request GET \
  --url https://api.sandbox.monite.com/v1/webhook_subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "event_types": [
        "<string>"
      ],
      "object_type": "account",
      "status": "enabled",
      "url": "<string>"
    }
  ],
  "next_pagination_token": "<string>",
  "prev_pagination_token": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-monite-version
string<date>
required

Query Parameters

​
order
enum<string>
default:asc

Sort order (ascending by default). Typically used together with the sort parameter.

Available options:
asc,
desc
​
limit
integer
default:100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

Required range: 1 <= x <= 100
​
pagination_token
string | null

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

​
sort
enum<string> | null

The field to sort the results by. Typically used together with the order parameter.

Available options:
created_at,
updated_at
​
object_type
enum<string> | null
Available options:
account,
accounting_connection,
approval,
approval_request,
approval_policy,
approval_policy_process,
batch_payment,
comment,
counterpart,
counterpart_address,
counterpart_bank_account,
counterpart_contact_person,
counterpart_partner_metadata,
counterpart_tax_id,
entity,
entity_bank_account,
entity_settings,
entity_user,
export,
overdue_reminder,
partner_settings,
payable,
payables_credit_note,
payables_purchase_order,
payable.line_item,
payment,
payment_intent,
payment_link,
payment_reminder,
product,
project,
receivable,
recurrence,
role,
tag,
todo_task,
workflow,
workflow_pipeline,
ocr_task,
delivery_note,
receipt,
transaction
​
created_at__gt
string<date-time> | null

Return only subscriptions created after the specified date and time.

​
created_at__lt
string<date-time> | null

Return only subscriptions created before the specified date and time.

​
created_at__gte
string<date-time> | null

Return only subscriptions created on or after the specified date and time.

​
created_at__lte
string<date-time> | null

Return only subscriptions created before or on the specified date and time.

Response

Successful Response

​
data
object[]
required

A set of webhook settings of different types returned per page

​
next_pagination_token
string | null

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you've reached the last page).

​
prev_pagination_token
string | null

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you've reached the first page).