Skip to content

Support

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

NameTypeRequiredDescription
idstringWebhook id

Response

FieldTypeAlwaysDescription
idstringWebhook id
urlstringHTTPS endpoint events are POSTed to
secretstringThe signing secret in clear. Shown exactly once, here — store it now; it cannot be read back and can only be replaced by rotating it
statusstringactive or disabled
createdAtstringISO-8601 creation timestamp
updatedAtstringISO-8601 last-update timestamp
eventTypesarrayEvent types this endpoint subscribes to
descriptionstringFree-form note, or null
secretPrefixstringFirst 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.

navigateselect