MessageWebhookBody
The MessageWebhookBody type of the TypeScript SDK, which mailboxes.setMessageWebhook take or answer.
type MessageWebhookBody = {
format?: ('parsed' | 'reference')
secret?: string | null
url: string
}Fields
| Field | Type | Description |
|---|---|---|
format | ('parsed' | 'reference') | Optional. The payload shape. Omit to keep (parsed for a new webhook); reference needs a deployment that mints capability URLs (400 webhook_format_unavailable) |
secret | string | null | Optional. HMAC signing secret, write-only. Omit to keep the stored one, a string to set or rotate it, null to clear it (unsigned) |
url | string | HTTPS endpoint on a public host |
Used by
| Method | What it does |
|---|---|
mailboxes.setMessageWebhook | Create or replace the mailbox's message webhook |