Documentation
Sign inGet started

bird webhooks rotate-secret

Usage

Code example
bird webhooks rotate-secret <webhook-id> [flags]

Description

Generates a new signing secret for the endpoint and returns it exactly once: store it immediately, it cannot be retrieved after this response. For 24 hours every delivery is signed with both the old and the new secret, so a receiver verifying with either keeps working while you roll the new one out; after the window the old secret stops signing. Verification details are in the webhooks guide.
An endpoint holds at most 5 concurrently valid secrets, so rotating repeatedly within the overlap window fails with WebhookTooManySecrets until an older secret expires.

Examples

Code example
bird webhooks rotate-secret <id>

Options

NameDescription
--idempotency-keyDeduplication key; a retry with the same key won't act twice
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird webhooks attemptsList delivery attempts
bird webhooks createCreate a webhook endpoint
bird webhooks deleteDelete a webhook endpoint
bird webhooks getGet a webhook endpoint
bird webhooks listList webhook endpoints
bird webhooks testSend a test event