Skip to content

realtime_webhook_secret_rotate

Rotate the webhook signing secret with an overlap window: the new secret signs immediately (returned ONCE), the previous one keeps verifying until its grace expiry

Tool

realtime_webhook_secret_rotate

Rotate the webhook signing secret with an overlap window: the new secret signs immediately (returned ONCE), the previous one keeps verifying until its grace expiry

Rotate the webhook signing secret with an overlap window: the new secret signs immediately (returned ONCE), the previous one keeps verifying until its grace expiry

Behavior

HTTP
POST /realtime/webhooks/:webhookId/secret/rotate

Arguments

Name
Type
Required
Description
webhookId
string
•
Webhook id

Response

Field
Type
Always
Description
prefix
string
•
Visible prefix of the new secret (X-Realtime-Key)
secret
string
•
New full signing secret — returned only once. Store it now.
previousExpiresAt
string
•
When the rotated-out secret stops verifying (grace window)

Try it

Rotate the webhook signing secret with an overlap window: the new secret signs immediately (returned ONCE), the previous one keeps verifying until its grace expiry.

When to use

Rotate the webhook signing secret with an overlap window: the new secret signs immediately (returned ONCE), the previous one keeps verifying until its grace expiry

Example

Ask your agent something like this:

Rotate the webhook signing secret with an overlap window: the new secret signs immediately (returned ONCE), the previous one keeps verifying until its grace expiry.

The agent will invoke realtime_webhook_secret_rotate with these arguments:

{
  "webhookId": "<webhookId>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select