Skip to content

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

Name
Type
Required
Description
id
string
•
Webhook endpoint id
url
string
—
New HTTPS delivery URL; omit to leave it unchanged
enabled
boolean
—
Switch delivery on (true) or off (false); omit to leave it unchanged
description
string
—
New human label, or null to clear it; omit to leave it unchanged
enabled_events
array
—
Replace the delivered event types; omit to leave them unchanged

Response

Field
Type
Always
Description
id
string
•
Webhook endpoint id
url
string
•
HTTPS URL that signed events are POSTed to
enabled
boolean
•
False if delivery is switched off — the endpoint is kept but nothing is sent to it
created_at
string
•
When the endpoint was registered (ISO 8601 UTC)
updated_at
string
•
When the endpoint was last changed (ISO 8601 UTC)
description
string
•
Human label for the endpoint; null if none was given
enabled_events
array
•
Event types this endpoint receives; anything else is not delivered to it

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.

↑↓navigate↵select