Support

support_webhook_update

Edit a registered endpoint: its url, the event types it subscribes to, its description or its status.

Tool

support_webhook_update

Edit a registered endpoint: its url, the event types it subscribes to, its description or its status.

Edit a registered endpoint: its url, the event types it subscribes to, its description or its status. Setting status to disabled 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 /support/webhooks/:id

Arguments

Name	Type	Required	Description
id	string	•	Webhook id
url	string	—	HTTPS endpoint the event is POSTed to. Plain http:// is rejected
status	string	—	active delivers events; disabled keeps the registration and stops delivery
eventTypes	array	—	Event types this endpoint subscribes to. One or more of support.message.created, support.thread.status-changed, support.thread.assigned, support.survey.published, support.response.created
description	string	—	Free-form note about what this endpoint is for, up to 1000 characters

Response

Field	Type	Always	Description
id	string	•	Webhook id
url	string	•	HTTPS endpoint events are POSTed to
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

Edit a registered endpoint: its url, the event types it subscribes to, its description or its status.

When to use

Example

Ask your agent something like this:

Edit a registered endpoint: its url, the event types it subscribes to, its description or its status.

The agent will invoke support_webhook_update with these arguments:

{
  "id": "<id>"
}