Skip to main content
POST
Enable 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.

Path Parameters

webhookId
string
required

Response

Webhook enabled

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

id
string
Example:

"whk_01H9Xa8F5dN6mP3q"

object
string
Example:

"webhook"

url
string
Example:

"https://partner.example/webhooks"

status
enum<string>

Webhook lifecycle state. suspended is set only by the service when the endpoint is unhealthy.

Available options:
enabled,
disabled,
suspended
statusReason
string | null

Set on transition to suspended; describes the down/suspend cause.

subscriptions
string[]
Example:
timeoutMs
integer

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

Example:

5000

notifyThresholdSecs
integer | null

Down-notification threshold (10 min – 1 day; default 1 h).

successCount
integer<int64>
failureCount
integer<int64>
mode
enum<string>
Available options:
live,
sandbox
createdAt
string<date-time>
updatedAt
string<date-time>