Skip to content

Realtime

realtime_webhook_update

Update a client webhook: url, event filter, description, active flag

Tool

realtime_webhook_update

Update a client webhook: url, event filter, description, active flag

Update a client webhook: url, event filter, description, active flag

Behavior

HTTP
PATCH /realtime/webhooks/:webhookId

Arguments

NameTypeRequiredDescription
urlstringEndpoint that receives signed lifecycle POSTs (https in production)
activebooleanInactive webhooks receive no deliveries
eventsarrayLifecycle event types this webhook receives
webhookIdstringWebhook id to update
descriptionstringFree-form note

Response

FieldTypeAlwaysDescription
idstring
urlstring
activeboolean
eventsarray
secretsarraySecret metadata only — never the secret itself
createdAtstring
updatedAtstring
descriptionstring

Try it

Update a client webhook: url, event filter, description, active flag.

When to use

Update a client webhook: url, event filter, description, active flag

Example

Ask your agent something like this:

Update a client webhook: url, event filter, description, active flag.

The agent will invoke realtime_webhook_update with these arguments:

{
  "webhookId": "<webhookId>"
}

Esc

Start typing to search the docs.

navigateselect