Rotate a Webhook signing secret

Changed on

Issue a new signing secret for a webhook. By default the previous secret keeps verifying for 24 hours so a receiver can be updated without dropping deliveries; pass revokeImmediately to end that window at once. The new secret is returned only here.

post/v1/webhooks/{id}/secret

Request

  • Base URL
    https://api.browserbase.com
  • Auth
    API key in header X-BB-API-Key

Path parameters

idstring uuid required

The webhook ID.

Request body

revokeImmediatelyboolean

Expire the old secret at once instead of honouring it for 24 hours. Use when responding to a leak; deliveries signed with the old secret stop verifying immediately.

Response

The new signing secret.

secretstring required

The new signing secret, prefixed whsec_.

Changes