Skip to main content

Rotate webhook signature secret

POST 
/v1/subscriptions/:id/rotate-secret

Generate a new signing secret for webhook signature verification.

Use Case: Rotate secrets periodically for security, or immediately if a secret is compromised.

Process:

  1. A new signature secret is generated
  2. Future webhook deliveries will use the new secret for signing
  3. Update your webhook endpoint to verify signatures using the new secret

Important: Update your webhook verification code with the new secret to avoid failed verifications.

Best Practice: Implement a grace period where both old and new secrets are accepted during rotation.

Request​

Responses​

Secret rotated successfully. Response includes the new masked secret.