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

Delete a webhook subscription

DELETE/api/v1/webhooks/{id}

Deletes a webhook subscription by id, scoped to the active Application's current Environment, stopping all future deliveries. Returns 404 when the subscription does not exist in this Environment. Responds 204 No Content and requires the webhook.manage permission.

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.

Path Parameters

idstring Required

Responses

Webhook subscription deleted

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X DELETE "https://auth.canopy-io.com/api/v1/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
GETList subscribable webhook event types
GETList delivery attempts for a webhook
GETGet a webhook subscription
PATCHUpdate a webhook subscription
 Was this page helpful?

Tell us how we can improve this guide.

Canopy