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

Name
Type
Required
Description
id
string
•
Identifier of the endpoint

Response

Field
Type
Always
Description
id
string
•
Identifier of the endpoint
url
string
•
HTTPS endpoint events are POSTed to
active
boolean
•
Whether deliveries are being attempted for it
secret
string
•
The signing secret — shown only here, store it now; it cannot be read back
createdAt
string
•
ISO 8601 registration timestamp
updatedAt
string
•
ISO 8601 timestamp of the last change
description
string
•
Free-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.

↑↓navigate↵select