Skip to content

message.enrich

POST

Called synchronously before a new mail is stored and delivered; the response enriches it. At most one endpoint per application.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-inboxcnx-signature
required

t=<unix seconds>,v1=<hex HMAC-SHA256>. The MAC covers <t>.<raw body> with the endpoint’s signing secret. During a secret rotation a second v1 carries the previous secret’s MAC. Reject a t older than 5 minutes.

string

Example 

t=1761206400,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd

t=<unix seconds>,v1=<hex HMAC-SHA256>. The MAC covers <t>.<raw body> with the endpoint’s signing secret. During a secret rotation a second v1 carries the previous secret’s MAC. Reject a t older than 5 minutes.

x-inboxcnx-event-id
required

The envelope’s id. Stable across retries: dedupe on it.

string

The envelope’s id. Stable across retries: dedupe on it.

Request Body

Section titled “Request Body”
Media typeapplication/json
object
id
required
string
>= 1 characters
createdAt
required
string
applicationId
required
string format: uuid
grantId
required
string | null format: uuid
externalUserId
required
string | null
type
required
string
Allowed values: message.enrich
data
required
object
message
required
object
id
required
string format: uuid
providerMessageId
required
string
providerThreadId
required
string | null
source
required
string
Allowed values: gmail m365 imap
receivedAt
required
string
sentAt
required
string | null
subject
required
string | null
from
required
Array<object> | null
object
name
required
string | null
email
required
string
sender
required
Array<object> | null
object
name
required
string | null
email
required
string
to
required
Array<object> | null
object
name
required
string | null
email
required
string
cc
required
Array<object> | null
object
name
required
string | null
email
required
string
bcc
required
Array<object> | null
object
name
required
string | null
email
required
string
replyTo
required
Array<object> | null
object
name
required
string | null
email
required
string
messageId
required
Array<string> | null
inReplyTo
required
Array<string> | null
references
required
Array<string> | null
size
required
integer
keywords
required
object
key
additional properties
boolean
labels
required
object
system
required
Array<string>
Allowed values: inbox archive drafts sent trash junk all flagged important
custom
required
Array<string>
language
required
string | null
preview
required
string | null
<= 256 characters
hasAttachment
required
boolean
body
required
object
text
required
string | null
html
required
string | null
attachments
required
Array<object>
object
id
required
string format: uuid
name
required
string | null
contentType
required
string | null
size
required
integer | null
disposition
required
string | null
cid
required
string | null
downloadUrl
required
string | null
raw
required
object
downloadUrl
required
string | null
enrichment
required
object
application
object
key
additional properties
lifecycle
object
providerReceivedAt
required
string
detectedAt
required
string | null
fetchedAt
required
string | null
processedAt
required
string | null
storedAt
required
string | null
webhookEnqueuedAt
required
string | null
webhookDeliveredAt
required
string | null
stateAt
string | null
deletedAt
string | null

Responses

Section titled “Responses”

200

Section titled “200”

The enrichment to store on the mail.

Media typeapplication/json
object
enrichment

Stored on the mail as enrichment.application. A JSON object of at most 16 KB serialized and 8 levels deep. Keys __proto__, constructor and prototype are refused, as are strings and keys with \u0000 or invalid Unicode. Absent or null: nothing to add.

object | null

Example 

{
  "enrichment": {
    "crmId": "42",
    "category": "support"
  }
}

204

Section titled “204”

Nothing to add.

default

Section titled “default”

One attempt, no retry. Within 5 seconds, body read included; at most 32 KB of the body are read. On any failure the mail is processed and delivered without enrichment.