v9

OpenAPI 3.1.02026-08-043703845.2 MB

Webhooks

List Webhooks

Returns a paginated list of webhook endpoints configured for an account, ordered by most recently created.

get/webhooks

Query parameters

account_idstring required

The unique identifier of the account to list webhooks for.

app_idstring

Only return webhooks attached to this app. Omit to list the account's own webhooks.

include_app_webhooksboolean

Also return webhooks attached to the account's apps, not just the account's own. Cannot be combined with app_id.

has_failuresboolean

Only return webhooks whose endpoint is currently failing — every delivery since the current failure streak began has been rejected. Clears as soon as a delivery succeeds.

firstinteger

The number of webhooks to return (default 20, max 100).

afterstring

A cursor; returns webhooks after this position.

lastinteger

The number of webhooks to return from the end of the range.

beforestring

A cursor; returns webhooks before this position.

Response

webhooks listed

Example response

{
  "data": [
    {
      "api_version": "v1",
      "disabled_reason": "delivery_failures",
      "events": [
        "invoice.created"
      ]
    }
  ]
}