Sign inGet Started

Rotate callback signing secret

POST
/v1/webhook-callbacks/rotate-signing-secret
bird webhooks callbacks rotate-signing-secret --yes
Réponse200
{
  "secret": "whsec_newbase64encodedvalue"
}

Generates a new signing secret for the workspace's SMS callback URLs and returns it exactly once: store it immediately, it cannot be retrieved after this response. The secret is shared by every callback URL in the workspace. For 24 hours deliveries are signed with both the old and the new secret, then the old one stops signing.

A workspace holds at most 5 concurrently valid secrets, so rotating repeatedly within the overlap window fails with WebhookTooManySecrets until an older secret expires.

Contenu de la réponse

secret
string
obligatoire

The new signing secret (whsec_ prefix). Shown only in this response: store it immediately, it cannot be retrieved again. Deliveries are signed with both this and the previous secret for 24 hours after rotation, then the previous secret stops signing.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.