Skip to content

observe_webhooks_rotate_secret

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

Tool

observe_webhooks_rotate_secret

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

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

Behavior

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

Arguments

NameTypeRequiredDescription
idstringIdentifier of the endpoint

Response

FieldTypeAlwaysDescription
idstringIdentifier of the endpoint
urlstringHTTPS endpoint events are POSTed to
activebooleanWhether deliveries are being attempted for it
secretstringThe signing secret — shown only here, store it now; it cannot be read back
createdAtstringISO 8601 registration timestamp
updatedAtstringISO 8601 timestamp of the last change
descriptionstringFree-form note given at registration, or null

Try it

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

When to use

Replace the signing secret of an endpoint and return the new one, 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, exactly once.

The agent will invoke observe_webhooks_rotate_secret with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect