POST/webhooks/{webhook_id}/signing-secret/rotate

Rotate a webhook signing secret

Rotates the signing secret for a webhook and returns the new secret. Payloads delivered after rotation use the new secret, while the previous secret remains valid for verifying payloads for 24 hours.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
webhook_idstringrequired
The UUID of the webhook whose signing secret to rotate.

1 status code
200Returns the webhook's object type and identifier, together with the new signing secret.
objectstringoptional
The type of object.
idstringoptional
The ID of the webhook.
signing_secretstringoptional
The new secret key used to verify webhook payloads.

Error handling

The webhook_id path parameter must be a UUID that identifies an existing webhook.