Sign in

v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB
webhooks

List webhooks

Lists all webhooks associated to the Management API key, optionally filtered by status.

get/webhooks

Query parameters

status'enabled' | 'disabled'

Filters by webhook status.

environmentstring

Filters by webhook environment ID.

cursorstring

Cursor token used for pagination. Response will contain items appearing after the given cursor.

limitnumber

Sets the maximum number of items contained in a single page.

Headers

X-API-Versionstring required

Management API version.

Response

List of webhooks matching the given query.

Example response

{
  "data": [
    {
      "id": "wh_HYv9YfsIIUjpvR",
      "description": "My Webhook",
      "url": "https://website.com/webhook"
    }
  ],
  "metadata": {
    "pagination": {
      "next_cursor": "eyJrZXlzIjpbImlkIl0sInZhbHVlcyI6WyJhZV9JRVdWQVhrQURyN3BiNFYzI"
    }
  }
}