latestOpenAPI 3.1.02026-08-102051102.0 KB

40ed0bdb89e1

Webhooks

Create a new webhook subscription for a tenant

post/api/v1/webhooks

Headers

idempotency-keystring uuid required

Required for mutating calls. Use a V4 UUID. The server stores the first result for 24h and returns it on subsequent retries with the same key.

Required for mutating calls. Use a V4 UUID. The server stores the first result for 24h and returns it on subsequent retries with the same key.

Request body

namestring required

Webhook subscription name

urlstring uri required

Webhook endpoint URL

eventTypesstring[] required

Event types to subscribe to

secretstring

Optional webhook signing secret

metadataMetadata

Response

Default Response