Sign in

v7

latestOpenAPI 3.1.0LGPL-3.0-or-laterraw.githubusercontent.com2026-04-27593295.9 KB
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