Rotate webhook secret
POST
/v1/webhooks/{id}/rotate-secret
Mint a fresh signing secret for one of the signed-in user's webhook subscriptions and stop signing with the old one immediately — the standard move after a suspected compromise, or just periodic hygiene. The delivery URL and description don't change. The new secret is returned exactly once, in this response — reconfigure your receiver with it right away.
Authorizations
Bearer
JWT bearer token from POST /v1/auth/login.
Type
HTTP (bearer)
or
ApiKey
Scoped API key for non-interactive clients (issued by PBI #1426).
Type
API Key (header: X-Api-Key)
Parameters
Path Parameters
id*
Type
Requiredstring
Format
"uuid"Responses
OK
application/json
Success body for POST /webhooks/{id}/rotate-secret.
The subscription whose secret was rotated.
Format
"uuid"The new raw signing secret — shown here exactly once. It replaces the previous
secret, which no longer signs deliveries.
The new signing secret's non-secret prefix.