Rotate webhook secret
Mint a new signing secret for an existing webhook subscription. Returns the new secret once.
v2 compatibility notes
POST /api/v2/webhooks/rotate-secret
Mint a new signing secret for an existing webhook subscription. X-Forge-Signature-V2 uses the new secret from the next delivery. Until previousSecretExpiresAt (at least 24 hours on), webhook-signature also carries a signature made with the replaced secret, so a receiver can deploy the new secret without dropping a delivery. A second rotation inside that window replaces the replaced secret: at most two are ever live. To end a leaked secret’s validity at once, revoke the subscription instead. See Rotating the secret.
Authentication
External App credential. Requires permissionwebhooks:manage.
Request body
Responses
webhook-signature, beside the new one.Related
Authorizations
Headers
1–255 printable ASCII characters (0x21–0x7E, no spaces), scoped to the calling credential. A repeat with the same key and request never runs the write again, a 5xx included: once the operation's permissions pass again it answers the identical status and body of the first response (Idempotent-Replayed: true, also sent as Idempotency-Replayed: true), unless the operation's own replay policy withholds it; a first response that was not stored (over 32 KiB, or carrying a one-time secret) answers its first status with only data.id (Idempotency-Replay-Disclosure: id-only) when it named one; otherwise 409 idempotency_result_unavailable; a repeat while the first is still running is 409 idempotency_key_in_flight, and the same key with a different request is 422 idempotency_key_reuse. Honoured for External App JWTs and platform and Personal keys; an External App's static companion key is not protected.
1 - 255
