bird webhooks rotate-secret
Usage
Code example
bird webhooks rotate-secret <webhook-id> [flags]Description
Mint a new signing secret, written once to a file only you can read and never printed; it cannot be retrieved afterward. Both the old and new secrets sign every delivery for 24 hours, after which the old one stops signing. An endpoint holds at most 5 valid secrets, so rotating repeatedly inside that window fails.
This is destructive and cannot be undone; pass --yes to confirm.
Examples
Code example
bird webhooks rotate-secret <id> --secret-out ./whsec.txt --yesOptions
Safety
| Name | Description |
|---|---|
--idempotency-key | Deduplication key; a retry with the same key won't act twice |
--yes | Confirm the action (required; the CLI never prompts) |
Options
| Name | Description |
|---|---|
--dry-run | Print the resolved request without sending it, then exit |
--response-schema | Print the fields this command returns, then exit |
--secret-out | Write the signing secret to this file, readable only by you; it defaults to webhook-secrets/<webhook-id> in the CLI's config directory, and the secret is never printed either way. A secret already in the file moves to <file>.replaced-<time>, since a rotated-out secret keeps signing for 24 hours. |
Related
| Name | Description |
|---|---|
bird webhooks attempts | List delivery attempts |
bird webhooks connect | Connect a connector to this workspace's events |
bird webhooks create | Create a webhook endpoint |
bird webhooks delete | Delete a webhook endpoint |
bird webhooks get | Get a webhook endpoint |
bird webhooks list | List webhook endpoints |
bird webhooks replay | Replay failed deliveries |
bird webhooks test | Test a webhook with a sample event |
bird webhooks update | Update a webhook endpoint |
Related resources
Continue with the documentation, guides and examples for this topic.