Update a webhook subscription

PATCH

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

Updates a webhook subscription's url, event_types, description, and/or is_active flag by id; omitted fields are left unchanged. When event_types is provided it is re-validated against the account-scope registry, and an unsupported type returns 400 (wildcard rules apply). Returns 404 for a subscription outside the Account and requires the account_webhook.manage scope; the signing secret is not affected or returned. Send the subscription's version as If-Match to refuse an update made over a newer change (409, version_mismatch).

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

Headers

If-Match
Optimistic-lock version of the resource. Send the `version` field returned on read; the server rejects with 409 if the row has changed since. Leave it out to skip the check; a header that names no version (not a whole number) is refused with 400 `if_match.invalid`.

Request body

application/json

urlstring Optional

event_typesstring[] Optional

descriptionstring Optional

is_activeboolean Optional

Responses

application/json

dataWebhookResponseDto*

application/json

errorApiErrorBodyDto*

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.

Returned object

WebhookResponseDtoView all properties on this resource

Request

curl -X PATCH "https://auth.canopy-io.com/api/v1/account-webhooks/value" \
  -H "If-Match: "3"" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "string",
    "event_types": [
      "string"
    ],
    "description": "string",
    "is_active": false
  }'

Response

{
  "data": {
    "id": "string",
    "scope": "environment",
    "url": "string",
    "event_types": [
      "string"
    ],
    "description": "string",
    "is_active": false,
    "created_at": "2026-04-20T12:00:00.000Z",
    "previous_secret_expires_at": "2026-04-20T12:00:00.000Z",
    "version": 0
  }
}

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
DELETEDelete a webhook subscription
POSTRotate a webhook subscription's signing secret

Was this page helpful?

Tell us how we can improve this guide.