Rotate a webhook signing secret

Issues a new whsec_ signing secret and returns it ONCE in this response. The previous secret keeps signing alongside it for expire_previous_in_seconds (default 86400, at most 86400; 0 retires it at once), so during that grace period Cybooks-Signature carries two v1= signatures and a receiver accepts either. Idempotency-Key is required, and a replayed response carries the secret again with Cache-Control: no-store. Requires the webhooks:write OAuth scope. The credential's user needs the manage_integrations permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Fields accepted to rotate a webhook signing secret. The schema identifies required and optional values.

POST /v1/webhook-subscriptions/{id}/rotate-secret.

expire_previous_in_seconds (0–86400, default 86400) is how long the
current secret keeps signing alongside the new one; 0 retires it at once.

integer
0 to 86400
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*