Disable a webhook destination

Stop deliveries to one destination without deleting it. Disabling a destination that is already disabled returns the same answer again rather than an error, so a retried request is never rejected.

post/v1/webhooks/{webhook_id}/disable

Request

  • Base URL: https://thirds.ai
  • URL: https://thirds.ai/v1/webhooks/{webhook_id}/disable
  • Auth: HTTP bearer

Path parameters

webhook_idstring required

The destination's public identifier, such as "wh_1f8b3c7d5e2a49061f8b3c7d5e2a4906".

Response

The destination, now disabled by owner request.

idstring required

The destination's public identifier: "wh_" followed by 32 lowercase hexadecimal characters.

urlstring uri required
eventsstring[] required

The selected events, always sorted and distinct.

status'enabled' | 'disabled' required
disabled_reason'owner_request' | 'delivery_failure' | 'null' nullable required

Why a disabled destination is disabled: the owner asked, or delivery failed repeatedly. Null while the destination is enabled.

display_prefixstring required

The first characters of the signing secret, enough to tell destinations apart in a list.

last_delivery_atstring date-time nullable required

Time of the most recent recorded attempt, including tests.

failure_countinteger required

Consecutive normal delivery failures. A success or enable resets it. Test events do not change it.

created_atstring date-time required
previous_secret_expires_atstring date-time nullable required

Set while a rotation overlap is running: until this instant every delivery also carries a signature made with the previous secret.

Changes

No recorded changes to this operation across all 1 revision of this API.