v1

latestOpenAPI 3.0.32026-07-26870417.2 KB

webhooks

Create Webhook

This endpoint creates a new webhook subscription

Refer to the webhooks section to get the list of available integration names

post/webhooks

Request body

hookUrlstring required

The URL where webhook events will be sent. Must be a valid HTTP or HTTPS URL

integrationMetadataobject

Optional metadata object for the webhook

integrationTypestring

The type of integration

typestring

The webhook type

namestring

Optional name for the webhook

Example request

{
  "hookUrl": "https://example.com/webhook",
  "integrationType": "webhook",
  "type": "webhook",
  "name": "My Webhook"
}

Response

201 Created

idstring

Unique identifier of the webhook subscription

subscribed_atstring

Timestamp when the webhook was subscribed

is_subscribedboolean

Whether the webhook is currently active

integration_namestring

Name of the event this webhook listens to

integration_typestring

Type of integration

typestring

Type of the subscription

org_idstring

Organization ID that owns this webhook

hook_urlstring

The URL where webhook events are sent

integration_idstring

Unique identifier of the integration

Example response

{
  "id": "0ef25935-0b78-4660-beeb-f17311793305",
  "subscribed_at": "2025-11-16T11:20:42.038+00:00",
  "is_subscribed": true,
  "integration_name": "ticket.created",
  "integration_type": "webhook",
  "type": "webhook",
  "integration_metadata": {
    "id": "28ee5da7-d6e5-438b-8b73-9eba97f08269",
    "name": "https://webhook.site/951e142b-d2e6-420d-a666-f2c4bd8e572c"
  },
  "org_id": "03a52dbe-b8af-47c5-9fd1-e5a622680cad",
  "hook_url": "https://webhook.site/951e142b-d2e6-420d-a666-f2c4bd8e572c",
  "integration_id": "28ee5da7-d6e5-438b-8b73-9eba97f08269"
}