GeneralWebhook subscriptions

Get webhook subscriptions

Returns a list of all webhook subscriptions (both active and disabled).

Headers

AuthorizationstringRequired

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

x-monite-versionstringRequired

Query parameters

orderenumOptional

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

Allowed values:
limitintegerOptional>=1<=100Defaults to 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.

pagination_tokenstringOptional

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.

sortenumOptional

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

Allowed values:
object_typeenumOptional
created_at__gtdatetimeOptional
Return only subscriptions created after the specified date and time.
created_at__ltdatetimeOptional
Return only subscriptions created before the specified date and time.
created_at__gtedatetimeOptional
Return only subscriptions created on or after the specified date and time.
created_at__ltedatetimeOptional
Return only subscriptions created before or on the specified date and time.

Response

Successful Response
datalist of objects
A set of webhook settings of different types returned per page
next_pagination_tokenstring or 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_tokenstring or 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).

Errors