Register webhook
POST
/v1/webhooks
Give the API a URL to push HMAC-signed notifications to whenever one of your books changes status — the headless-agent counterpart to the SignalR status hub. The URL must be a public http(s) address, never a private or loopback one. The signing secret is returned exactly once, in this response — store it now to verify deliveries, because it can't be retrieved again.
Authorizations
Bearer
JWT bearer token from POST /v1/auth/login.
Type
HTTP (bearer)
or
ApiKey
Scoped API key for non-interactive clients (issued by PBI #1426).
Type
API Key (header: X-Api-Key)
Request Body
application/json
One of
Request body for registering a webhook subscription (PBI #2003): the absolute http(s) endpoint to
deliver signed status changes to, plus an optional human label.
An optional human-readable label to recognize this subscription by.
The absolute http(s) endpoint to deliver signed status-change notifications to; must be a public address, never loopback/private/link-local.
Responses
Created
application/json
Success body for POST /webhooks: the newly-registered subscription, with its signing
secret shown exactly once.
When the subscription was registered.
Format
"date-time"The caller-supplied label for this subscription.
Stable identifier for this subscription (used to delete or rotate it later).
Format
"uuid"The raw signing secret — shown here exactly once. Store it now to verify
delivery signatures; it can never be retrieved again, only rotated.
The signing secret's non-secret prefix, safe to display for recognition.
The endpoint deliveries are pushed to.