WebhookDeliveryMessage
The parsed message; degraded forms carry bodiesOmitted, never null.
The parsed message; degraded forms carry bodiesOmitted, never null
type WebhookDeliveryMessage = {
attachments: WebhookDeliveryAttachment[]
attachmentsTruncated?: true
auth: WebhookDeliveryAuth
bodiesOmitted?: ('too_large' | 'unavailable' | 'parse_failed' | 'not_requested')
cc: ContentAddress[]
date: number | null
from: ContentAddress[]
headers: Record<string, string[]>
html: string | null
htmlTruncated?: true
inReplyTo: string | null
messageId: string | null
references: string[]
replyTo: ContentAddress[]
subject: string | null
text: string | null
textTruncated?: true
to: ContentAddress[]
}Fields
| Field | Type | Description |
|---|---|---|
attachments | WebhookDeliveryAttachment[] | |
attachmentsTruncated | true | Optional. The attachment list was cut at the entry ceiling |
auth | WebhookDeliveryAuth | |
bodiesOmitted | ('too_large' | 'unavailable' | 'parse_failed' | 'not_requested') | Optional. Present when the bodies are absent, and why. text/html/attachments are then empty as a matter of ignorance, not of fact — except for 'not_requested', which is the webhook asking for the 'reference' format: no MIME walk was performed and the original message is at rawUrl |
cc | ContentAddress[] | |
date | number | null | Date header, epoch seconds (the envelope's receivedAt is separate) |
from | ContentAddress[] | |
headers | Record<string, string[]> | Every header field, lowercased name mapped to its values in document order. Bounded by the 64 KB head window; a longer header block is reported partially |
html | string | null | Decoded, charset-transcoded text/html body; null when the message has none |
htmlTruncated | true | Optional. The HTML body hit the 1 MiB decoded ceiling |
inReplyTo | string | null | |
messageId | string | null | Message-ID header value, or null |
references | string[] | References header Message-IDs |
replyTo | ContentAddress[] | |
subject | string | null | |
text | string | null | Decoded, charset-transcoded text/plain body; null when the message has none |
textTruncated | true | Optional. The text body hit the 1 MiB decoded ceiling |
to | ContentAddress[] |