v1
latestOpenAPI 3.0.12026-07-244011,5573.5 MBWebhooks
Archive a webhook
Archives (soft-deletes) the supplied webhook. The webhook stops firing immediately but its definition is retained. Fails with 400 webhook_associated_with_webhook_controller_action if the webhook is referenced by a controller action, or 400 webhook_associated_with_webhook_user_subscription_channel if it is referenced by a user subscription channel. Remove those references before archiving.
delete/v6/webhooks/{webhook_id}
Path parameters
webhook_idstring required
The id of the webhook to be deleted.
Response
Archived webhook.
Example response
{
"client_key_id": "handlebars@buildtime:{{clientKeyId}}",
"created_at": "2025-10-24T02:00:00-07:00",
"default_method": "handlebars@buildtime:{{defaultMethod}}",
"description": "handlebars@buildtime:{{description}}",
"enabled": "handlebars@buildtime:{{enabled}}",
"name": "handlebars@buildtime:{{name}}",
"request": "handlebars@buildtime:{{request}}",
"response_handler": "handlebars@buildtime:{{responseHandler}}",
"retry_intervals": [
"PT42S"
],
"updated_at": "2025-10-24T02:00:00-07:00",
"url": "handlebars@buildtime:{{url}}"
}