Update a webhook subscription

PATCH

/api/v1/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 Environment's registry, and an unsupported type returns 400 (wildcard rules apply). Returns 404 for a subscription outside this Environment and requires the webhook.manage permission; the signing secret is not affected or returned.

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

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*

Returned object

WebhookResponseDtoView all properties on this resource

Request

curl -X PATCH "https://auth.canopy-io.com/api/v1/webhooks/value" \
  -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"
  }
}

GETList webhook subscriptions
POSTCreate a webhook subscription
GETList subscribable webhook event types
GETList delivery attempts for a webhook
GETGet a webhook subscription
DELETEDelete a webhook subscription

Was this page helpful?

Tell us how we can improve this guide.