Webhooks

List webhooks

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

Required permissions:

  • developer:manage_webhook
get/webhooks

Query parameters

afterstring nullable

Returns the elements in the list that come after the specified cursor.

beforestring nullable

Returns the elements in the list that come before the specified cursor.

firstinteger nullable

Returns the first n elements from the list.

Example:42
lastinteger nullable

Returns the last n elements from the list.

Example:42
company_idstring required

The unique identifier of the company to list webhooks for.

Example:biz_xxxxxxxxxxxxxx

Response

A successful response

Example response

{
  "data": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "hook_xxxxxxxxxxxxx",
      "url": "https://example.com/path"
    }
  ]
}

Changes