Skip to content

observe_webhooks_update

Edit a registered endpoint: its url, its description, or whether it is active.

Tool

observe_webhooks_update

Edit a registered endpoint: its url, its description, or whether it is active.

Edit a registered endpoint: its url, its description, or whether it is active. Setting active to false keeps the registration and stops delivery. Omit a field to leave it alone; pass null to clear the description. The signing secret is not editable here — rotate it instead.

Behavior

HTTP
PATCH /observe/webhooks/:id

Arguments

NameTypeRequiredDescription
idstringIdentifier of the endpoint to change
urlstringNew HTTPS endpoint. Plain http:// is rejected
activebooleanfalse keeps the registration and stops delivery; true resumes it
descriptionstringNew note, or null to clear it

Response

FieldTypeAlwaysDescription
idstringIdentifier of the endpoint
urlstringHTTPS endpoint events are POSTed to
activebooleanWhether deliveries are being attempted for it
createdAtstringISO 8601 registration timestamp
updatedAtstringISO 8601 timestamp of the last change
descriptionstringFree-form note given at registration, or null

Try it

Edit a registered endpoint: its url, its description, or whether it is active.

When to use

Edit a registered endpoint: its url, its description, or whether it is active. Setting active to false keeps the registration and stops delivery. Omit a field to leave it alone; pass null to clear the description. The signing secret is not editable here — rotate it instead.

Example

Ask your agent something like this:

Edit a registered endpoint: its url, its description, or whether it is active.

The agent will invoke observe_webhooks_update with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect