v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

WebhookSubscriptions

ListWebhookSubscriptions

Lists all webhook subscriptions owned by your application.

get/v2/webhooks/subscriptions

Query parameters

cursorstring

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.

For more information, see Pagination.

include_disabledboolean

Includes disabled Subscriptions. By default, all enabled Subscriptions are returned.

sort_order'DESC' | 'ASC'

The order (e.g., chronological or alphabetical) in which results from a request are returned.

Sorts the returned list by when the Subscription was created with the specified order. This field defaults to ASC.

limitinteger

The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value.

Default: 100

Response

Success

cursorstring

The pagination cursor to be used in a subsequent request. If empty, this is the final response.

For more information, see Pagination.

Example response

{
  "subscriptions": [
    {
      "api_version": "2021-12-15",
      "created_at": "2022-01-10 23:29:48 +0000 UTC",
      "enabled": true,
      "event_types": [
        "payment.created",
        "payment.updated"
      ],
      "id": "wbhk_b35f6b3145074cf9ad513610786c19d5",
      "name": "Example Webhook Subscription",
      "notification_url": "https://example-webhook-url.com",
      "updated_at": "2022-01-10 23:29:48 +0000 UTC"
    }
  ]
}