Skip to content

Mail

mail_webhook_update

Update a webhook endpoint (url, enabled_events, description, or enable/disable).

Tool

mail_webhook_update

Update a webhook endpoint (url, enabled_events, description, or enable/disable).

Update a webhook endpoint (url, enabled_events, description, or enable/disable).

Behavior

HTTP
PATCH /mail/webhooks/:id

Arguments

NameTypeRequiredDescription
idstringWebhook endpoint id
urlstringHTTPS URL that signed events are POSTed to
enabledbooleanEnable (true) or disable (false) delivery
descriptionstringOptional human label
enabled_eventsarrayEvent types to deliver. One or more of: email.delivered, email.bounced, email.complained, email.suppressed, email.opened, email.clicked

Response

FieldTypeAlwaysDescription
idstring
urlstring
enabledboolean
created_atstring
updated_atstring
descriptionstring
enabled_eventsarray

Try it

Update a webhook endpoint (url, enabled_events, description, or enable/disable).

When to use

Update a webhook endpoint (url, enabled_events, description, or enable/disable).

Example

Ask your agent something like this:

Update a webhook endpoint (url, enabled_events, description, or enable/disable).

The agent will invoke mail_webhook_update with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect