Skip to main content
POST
Disable the webhook endpoint

Authorizations

Authorization
string
header
required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Path Parameters

clientCode
string
required

Stable non-sensitive Client code authorized by the Integration grant.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Body

application/json

One uncompressed resource representation, limited to 256 KiB.

The body is of type object.

Response

The endpoint is disabled.

disabledReason
enum<string> | null
required

Why delivery stopped. Null while the endpoint is active. Configure the endpoint again after fixing the cause.

Available options:
client_disabled,
destination_unsafe,
grant_revoked
secretVersion
integer
required

Increases each time the signing secret is rotated.

Required range: 1 <= x <= 9007199254740991
status
enum<string>
required
Available options:
active,
disabled
url
string
required
signingSecret
string

Signing secret. Returned only when the endpoint is first configured or the secret is rotated; store it immediately.