1. Docs
  2. API Reference
  3. Rotate a webhook subscription's signing secret

Rotate a webhook subscription's signing secret

POST/api/v1/webhooks/{id}/rotate-secret

Generates a new signing secret for one webhook subscription id. The new secret is returned only in this response and is never retrievable again. The replaced secret keeps verifying for 24 hours: during that window every delivery's X-Canopy-Signature carries two space-separated v1, values, the new secret's first, and previous_secret_expires_at says when the window closes. A rotation inside an open window replaces the windowed secret rather than keeping a third. Send expire_previous: "now" for a leaked secret to skip the window; previous_secret_expires_at is then null. Returns 404 for an unknown subscription, writes a webhook.secret_rotated audit row, and requires webhook.manage.

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 webhook.manageIntegrations

Create, update, and delete 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

  • X-Canopy-Environment

    The id of the Environment this request acts in. Required with an account API key, which belongs to the Account and names its Environment per request; an Environment key may send it only to name its own Environment. A missing header for an account key answers `400` (`api_key.environment_required`), one naming no Environment of the key's Account `400` (`api_key.environment_not_found`), and one naming another Environment than an Environment key's own `400` (`api_key.environment_mismatch`).

Request body

application/json

expire_previousenum Optional

`window` (the default) keeps the retired secret verifying for 24 hours so the receiver can roll the new value out. `now` stops it the moment the rotation lands, for a secret that has leaked.

one of "now" · "window"

Responses

application/json

  • dataWebhookSecretRotatedResponseDto*

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

WebhookSecretRotatedResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/webhooks/value/rotate-secret" \
  -H "X-Canopy-Environment: value" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "expire_previous": "now"
  }'
Response
{
  "data": {
    "id": "string",
    "url": "string",
    "secret": "string",
    "previous_secret_expires_at": "2026-04-20T12:00:00.000Z"
  }
}
 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
DELETEDelete a webhook subscription
 Was this page helpful?

Tell us how we can improve this guide.

Canopy