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 | — | HTTPS URL that signed events are POSTed to |
| enabled | boolean | — | Enable (true) or disable (false) delivery |
| description | string | — | Optional human label |
| enabled_events | array | — | Event types to deliver. One or more of: email.delivered, email.bounced, email.complained, email.suppressed, email.opened, email.clicked |
Response
| Field | Type | Always | Description |
|---|---|---|---|
| id | string | • | |
| url | string | • | |
| enabled | boolean | • | |
| created_at | string | • | |
| updated_at | string | • | |
| description | string | • | |
| enabled_events | array | • |
Try it
Update a webhook endpoint (url, enabled_events, description, or enable/disable).