v1

latestOpenAPI 3.1.02026-07-2489171167.4 KB

Webhooks

Get webhooks by account ID

Retrieves a list of webhooks.

get/webhooks

Query parameters

include_event_namesboolean

Whether to include event names in the response

Response

Returns a list of webhooks.

idstring required

The unique identifier of the webhook subscriber

urlstring uri required

The URL that will receive webhook events

descriptionstring

Optional description of the webhook subscription

eventNamesstring[] required

The names of the events the subscriber is subscribed to

Example response

[
  {
    "id": "123e4567426614174000",
    "url": "https://example.com/webhook-receiver",
    "description": "Notification endpoint for service desk events",
    "eventNames": [
      "sr.created",
      "sr.updated"
    ]
  }
]