Notifications Webhooks

Lists all webhooks for an account

Lists all of the webhook subscriptions that have been configured for your account.

get/accounts/{account_id}/webhooks

Request

Query parameters

page_sizeinteger

A limit on the number of objects to be returned, between 1 and 100.

start_afterstring

Returns a list of objects after the provided pagination cursor, using the next_cursor from the previous response.

end_beforestring

Returns a list of objects that come before the provided pagination cursor. This is used for navigating to a previous page.

Response

A list of webhooks was retrieved successfully.

has_moreboolean

A flag that's true if there are more webhooks to retrieve in a subsequent request.

Example response

{
  "webhooks": [
    {
      "id": "01JPVZD75DW4KRP7MPFMF6KGZX",
      "url": "https://example.com/webhook",
      "events": [
        "target-group-updated",
        "quota-fill-registered"
      ],
      "compression": "gzip",
      "created_at": "2023-01-01T23:00:00.000Z",
      "updated_at": "2023-01-01T23:05:00.000Z"
    }
  ],
  "has_more": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.