Tool
mail_webhook_create
Register a webhook endpoint for the current product.
Register a webhook endpoint for the current product. Returns the signing secret ONCE.
Behavior
- HTTP
POST /mail/webhooks
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | • | HTTPS URL that signed events are POSTed to |
| 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 | • | |
| secret | string | • | |
| enabled | boolean | • | |
| created_at | string | • | |
| updated_at | string | • | |
| description | string | • | |
| enabled_events | array | • |
Try it
Register a webhook endpoint for the current product.