Register a webhook
Registers a webhook subscription for an event type. Spirii generates the signing secret and returns it once in this response — store it securely, it is never shown again.
Headers
Client-generated unique key per operation intent (UUID). Same key + identical body replays the original response; same key + different body returns 409.
Body
A name to help you recognise this subscription.
255HTTPS endpoint that deliveries are POSTed to.
The event type to subscribe to. Must be a known type from GET /webhooks/event_types.
1000Pin a payload API version.
50Custom headers sent with each delivery. Values are stored write-only and never returned.
Response
Platform-assigned stable identifier.
Human-readable name for the subscription.
HTTPS endpoint deliveries are POSTed to.
The event type this subscription receives.
ACTIVE, PAUSED, FAILED Names of configured custom headers. Header values are never returned.
Consecutive delivery failures since the last success.
The signing secret. Shown only on creation and rotation — store it securely, it is never returned again.
Pinned payload API version.