webhooks

Register a webhook endpoint

Registers a URL to receive webhook events. The HMAC signing secret is returned only in the creation response — store it securely. Payloads are signed with HMAC-SHA256 and delivered in the X-Webhook-Signature header.

post/webhooks

Headers

Idempotency-Keystring

Idempotency key for safe retries (required for POST/PUT)

Request body

urlstring uri required

eventsstring[]

Event types to subscribe to (empty = all)

Response

Webhook endpoint created (includes secret)

idstring uuid required

tenantIdstring uuid required

urlstring uri required

eventsstring[]

status'ACTIVE' | 'DISABLED' required

secretstring

Only returned on creation

createdAtstring date-time required

Changes

Changed in 1 of the 7 revisions of this API.1

Mar 19, 202682dff8901b0c1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history