1. Docs
  2. API Reference
  3. Delete a webhook subscription

Delete a webhook subscription

DELETE/api/v1/account-webhooks/{id}

Deletes a webhook subscription by id, in the Account, stopping all future deliveries. Returns 404 when the subscription does not exist in the Account. Responds 204 No Content and requires the account_webhook.manage scope.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Requires permission account_webhook.manageAccount

Create, update, and delete account-tier webhooks. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Path Parameters

idstring Required

Responses

Webhook subscription deleted

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Request
curl -X DELETE "https://auth.canopy-io.com/api/v1/account-webhooks/value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
HTTP/1.1 204 Webhook subscription deleted

(empty body)
 Related endpoints
GETList webhook subscriptions
POSTCreate a webhook subscription
GETActive/inactive webhook counts for the Account
GETList subscribable webhook event types
GETList delivery attempts for a webhook
GETGet a webhook subscription
PATCHUpdate a webhook subscription
POSTRotate a webhook subscription's signing secret
 Was this page helpful?

Tell us how we can improve this guide.

Canopy