MessageWebhook
The MessageWebhook type of the TypeScript SDK, which mailboxes.getMessageWebhook and mailboxes.setMessageWebhook take or answer.
type MessageWebhook = {
createdAt: number
format: ('parsed' | 'reference')
hasSecret: boolean
updatedAt: number
url: string
}Fields
| Field | Type | Description |
|---|---|---|
createdAt | number | When the webhook was first set (epoch seconds) |
format | ('parsed' | 'reference') | The payload shape: parsed (decoded bodies and inlined attachments) or reference (headers plus a capability rawUrl) |
hasSecret | boolean | Whether each POST is signed (X-OpenEmail-Signature, HMAC-SHA-256 over the body); the secret itself is write-only |
updatedAt | number | When it last changed (epoch seconds) |
url | string | Where each message that lands in this mailbox is POSTed (the incoming-email payload), however it got there: any of its addresses, a pattern or catch-all, a group, a forward, a delivery-status or platform notice, whether the mailbox keeps it or not |
Used by
| Method | What it does |
|---|---|
mailboxes.getMessageWebhook | Read the mailbox's message webhook |
mailboxes.setMessageWebhook | Create or replace the mailbox's message webhook |