Sign in

v1

latestOpenAPI 3.1.02026-07-2489171167.4 KB
Webhooks

Create a new webhook subscription

Creates a new webhook subscriber with subscription for the specified events.

post/webhooks

Request body

urlstring uri required

The HTTPS URL that will receive webhook events

signatureKeystring

The optional key used to sign the webhook events

descriptionstring

Optional description of the webhook subscription

eventNamesstring[] required

The names of the events to subscribe to

Example request

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

Response

Webhook subscription created successfully

idstring required

The id of the created webhook subscription

Example response

{
  "id": "123e4567426614174000"
}