Create Webhook Subscription
mail_webhook_createSet up an outbound webhook for your email domain to receive real-time notifications for incoming mail or approval requests, including a signing secret for verification.
Instructions
Create an outbound webhook subscription. Returns subscription metadata and the displayed signing secret (whs_...). Deny-by-default for OAuth tokens.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Webhook target URL (https:// required unless private target granted) | |
| events | Yes | Events to subscribe to ('mail.received', 'approval.requested') | |
| address | Yes | Identity email address to receive events for | |
| description | No | Optional human-readable description (max 1000 characters) | |
| contentScope | No | Payload content scope: 'metadata' (default) or 'preview' (admin only) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| url | Yes | ||
| state | Yes | ||
| events | Yes | ||
| secret | No | ||
| address | Yes | ||
| createdAt | No | ||
| description | No | ||
| contentScope | No | ||
| secretPrefix | No | ||
| signatureScheme | No | ||
| timestampToleranceSec | No |