Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Headers

Idempotency-Key
string
required

Unique key to prevent duplicate requests. Required on all POST requests.

Body

application/json
url
string
required
Example:

"https://partner.example/webhooks"

subscriptions
string[]
required
Example:
timeoutMs
integer

Per-webhook HTTP timeout in milliseconds. Default 5000, hard cap 10000.

notifyThresholdSecs
integer

Down-notification threshold in seconds (600 – 86400; default 3600).

Response

Webhook created

webhook
object
required

A partner-configured webhook endpoint. The signing key is never serialized back; it is returned in cleartext only from create/rotate-key.

signingKey
string
required

Cleartext HMAC signing key. Shown once — store it immediately; it is never returned again.