Skip to main content

WebhookStatus

disabledReason object

Why delivery stopped; null while active. Send PUT /webhook again to resume where it stopped.

anyOf
WebhookDisabledReason

Why delivery stopped.

FAILING: the endpoint failed every attempt for 24 hours. GONE: the endpoint answered 410 Gone. UNRESTRICTED_VISIBILITY: the account can now see every client's data, which webhooks do not serve.

Possible values: [FAILING, GONE, UNRESTRICTED_VISIBILITY]

stateWebhookStreamStaterequired

Whether deliveries of this type are being sent.

Possible values: [ACTIVE, DISABLED]

typeWebhookDataTyperequired

What a webhook delivers. Each type is delivered as its own ordered stream.

Possible values: [EVENT]

WebhookStatus
{
"disabledReason": "FAILING",
"state": "ACTIVE",
"type": "EVENT"
}