v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB

Webhook Subscriptions

Search Webhook Subscriptions

Endpoint to search WebhookSubscriptions using filtering parameters.

get/business/v2/webhooks/subscriptions

Query parameters

webhookUrlstring

The url of the WebhookSubscription.

Example:https://your_domain.com/xx/xx

enabledEventsWebhookEventName[]

The list of the enabled events of the search.

activeboolean

The status of the webhook (if false, notifications are not sent).

descriptionstring

The description of the WebhookSubscription.

Example:Transactions and user webhook

pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3

It indicates the specific page to display (the counter starts from zero).

sinteger

It indicates the number of items per page.

Example:25

It indicates the number of items per page.

d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC

It indicates how the pages are ordered.

propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The result is an array containing WebhookSubscriptions.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "webhook_url": "https://your_domain.com/xx/xx",
      "description": "Report updates",
      "active": true,
      "creation_date": "2017-06-01T12:48:40Z",
      "last_update": "2017-06-01T12:48:40Z"
    }
  ]
}