Skip to content

message.updated

POST

The provider changed the state of a delivered mail: its folders, labels or flags. Carries the full new state and the previous value of each changed field.

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.updated
data
required
object
message
required
object
id
required
string format: uuid
providerMessageId
required
string
providerThreadId
required
string | null
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>
stateAt
required
string
previous
required
object
keywords
object
key
additional properties
boolean
labels
object
system
required
Array<string>
Allowed values: inbox archive drafts sent trash junk all flagged important
custom
required
Array<string>

Responses

Section titled “Responses”

2XX

Section titled “2XX”

Delivered. The body is ignored.

default

Section titled “default”

A 408, 429, 5xx, a timeout or a network error is retried with backoff. Any other status, and a redirect (never followed), ends the delivery as failed.