Skip to content

support_webhook_rotate_secret

Replace the signing secret of an endpoint and return the new one in clear, exactly once.

Tool

support_webhook_rotate_secret

Replace the signing secret of an endpoint and return the new one in clear, exactly once.

Replace the signing secret of an endpoint and return the new one in clear, exactly once. The old secret stops verifying immediately — there is no grace window, so update the receiver before rotating

Behavior

HTTP
POST /support/webhooks/:id/rotate-secret

Arguments

Name
Type
Required
Description
id
string
•
Webhook id

Response

Field
Type
Always
Description
id
string
•
Webhook id
url
string
•
HTTPS endpoint events are POSTed to
secret
string
•
The signing secret in clear. Shown exactly once, here — store it now; it cannot be read back and can only be replaced by rotating it
status
string
•
active or disabled
createdAt
string
•
ISO-8601 creation timestamp
updatedAt
string
•
ISO-8601 last-update timestamp
eventTypes
array
•
Event types this endpoint subscribes to
description
string
•
Free-form note, or null
secretPrefix
string
•
First characters of the signing secret, to tell endpoints apart. Never the whole secret

Try it

Replace the signing secret of an endpoint and return the new one in clear, exactly once.

When to use

Replace the signing secret of an endpoint and return the new one in clear, exactly once. The old secret stops verifying immediately — there is no grace window, so update the receiver before rotating

Example

Ask your agent something like this:

Replace the signing secret of an endpoint and return the new one in clear, exactly once.

The agent will invoke support_webhook_rotate_secret with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select