Skip to Content

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

FieldTypeDescription
attachmentsWebhookDeliveryAttachment[]
attachmentsTruncatedtrueOptional. The attachment list was cut at the entry ceiling
authWebhookDeliveryAuth
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
ccContentAddress[]
datenumber | nullDate header, epoch seconds (the envelope's receivedAt is separate)
fromContentAddress[]
headersRecord<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
htmlstring | nullDecoded, charset-transcoded text/html body; null when the message has none
htmlTruncatedtrueOptional. The HTML body hit the 1 MiB decoded ceiling
inReplyTostring | null
messageIdstring | nullMessage-ID header value, or null
referencesstring[]References header Message-IDs
replyToContentAddress[]
subjectstring | null
textstring | nullDecoded, charset-transcoded text/plain body; null when the message has none
textTruncatedtrueOptional. The text body hit the 1 MiB decoded ceiling
toContentAddress[]

Used in

WebhookDeliveryPayload.

On this page