Retrieve an event

Returns one event by id — the id of the envelope a webhook delivered, which is also the AIInbx-Event-ID header and a delivery’s event_id.

GET/events/{event_id}

Authorization

AuthorizationBearer token (API key) · headerrequired

Pass an AI Inbx API key as a Bearer token.

Path parameters

event_idstringrequired

The prefixed event ID.

matches ^[a-z]+_[0-9a-f]{32}$

Header parameters

AIInbx-Workspacestring

Workspace id from GET /workspaces, for an OAuth token that reaches several.

min length 1

Responses

200

Success.

One of:

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

email_idstringrequired

The email, eml_…. Retrieve it for bodies and headers.

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

The conversation it belongs to.

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | nullrequired

The domain the message went through: received on or sent from. Null when it went through a mailbox.

Show properties

Any of:

string

string

null

null

mailbox_idstring | nullrequired

The mailbox the message went through: synced from or sent with. Null when it went through a domain.

Show properties

Any of:

string

string

null

null

fromstring<email>required

The sender.

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

tostring<email>[]required

The recipients on the envelope.

subjectstringrequired

The subject line.

snippetstringrequired

A short preview of the body.

attachmentsobject[]

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

filenamestringrequired

content_typestringrequired

sizeintegerrequired

min 0 · max 9007199254740991

preparationstringrequired

Allowed:readypartialunsupportedfailed

emailobject | null

Only on an endpoint whose payload is full: the email, exactly as GET /emails/{id}?include=attachment_content returns it. Read when the delivery is sent, so a retry carries freshly signed URLs. Null when it could not be included — the message no longer exists, or the body would pass 4 MB with it; read the email by email_id instead.

Show properties

Any of:

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

directionstringrequired

Allowed:inboundoutbound

statusstringrequired

Allowed:draftscheduledcanceleddiscardedqueuedsendingsentdeliveredbouncedcomplainedfailedreceived

fromobjectrequired

Show properties

namestring | null

Show properties

Any of:

string

string

null

null

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

tostring<email>[]required

ccstring<email>[]required

bccstring<email>[]required

reply_tostring<email>[]required

subjectstringrequired

snippetstringrequired

htmlstring | nullrequired

Show properties

Any of:

string

string

null

null

textstring | nullrequired

Show properties

Any of:

string

string

null

null

categorystring | nullrequired

Show properties

Any of:

string

string

null

null

verdictsobject | nullrequired

Show properties

Any of:

object

spamstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

spfstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

dkimstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

dmarcstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

null

null

suppression_keystring | nullrequired

Show properties

Any of:

string

string

null

null

message_idstringrequired

The RFC Message-ID, without angle brackets.

in_reply_tostring | nullrequired

The Message-ID of the message this one answers, without angle brackets. Null when it answers none.

Show properties

Any of:

string

string

null

null

idempotency_keystring | nullrequired

Show properties

Any of:

string

string

null

null

created_atstring<date-time>required

When it took its place in its thread. A draft's moves to when it is sent — draft.drafted_at keeps when it was written.

scheduled_atstring<date-time> | nullrequired

Show properties

Any of:

string<date-time>

string<date-time>

null

null

sent_atstring<date-time> | nullrequired

Show properties

Any of:

string<date-time>

string<date-time>

null

null

draftobject | nullrequired

Show properties

Any of:

object

drafted_atstring<date-time>required

edited_atstring<date-time> | nullrequired

When its content last changed before it was sent. Null when it went as written.

Show properties

Any of:

string<date-time>

string<date-time>

null

null

review_urlstring<uri> | nullrequired

Where a person reviews, edits and sends it in the console.

Show properties

Any of:

string<uri>

string<uri>

null

null

null

null

attachmentsobject[]required

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

filenamestringrequired

content_typestringrequired

sizeintegerrequired

min 0 · max 9007199254740991

cidstring | nullrequired

Show properties

Any of:

string

string

null

null

download_urlstring<uri> | nullrequired

Signed URL for the original bytes, good until expires_at. Opens without the API key, so treat it as a secret — and do not send the key to it: storage answers a request that carries an Authorization header with 400. To keep a reference, store the attachment id and call GET /attachments/{id}. Null when the bytes are gone.

Show properties

Any of:

string<uri>

string<uri>

null

null

expires_atstring<date-time> | nullrequired

When download_url and preparation.content_url stop working — an hour after the response. Read the email again, or call the download endpoint with the attachment ID, for fresh ones.

Show properties

Any of:

string<date-time>

string<date-time>

null

null

preparationobject | nullrequired

Show properties

Any of:

object

statusstringrequired

Allowed:readypartialunsupportedfailed

formatstring | nullrequired

Show properties

Any of:

string

string

null

null

pagesinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

warningsstring[]required

content_urlstring<uri> | nullrequired

Signed URL for the prepared text, good until the attachment's expires_at. Opens without the API key — and only without it: storage answers a request that carries an Authorization header with 400. Null when there is no prepared text.

Show properties

Any of:

string<uri>

string<uri>

null

null

textstring | null

Show properties

Any of:

string

string

null

null

null

null

stripped_textstring | nullrequired

What this message says: typed text only, quoted conversation and signature removed. A signature the thread has not seen from this sender stays — it is where the name and role are.

Show properties

Any of:

string

string

null

null

stripped_htmlstring | nullrequired

The HTML part with the same cut as stripped_text: quoted conversation and repeated signature removed, an answer typed into the quote kept under the line it answers. Null when the message has no HTML part or its markup could not be matched to the cut.

Show properties

Any of:

string

string

null

null

segmentsobject[]required

Show properties

Array of object

kindstringrequired

Allowed:writtenquotedsignature

textstringrequired

referencesstring[]required

The Message-IDs of the conversation so far, oldest first, without angle brackets.

headersobject[]required

Show properties

Array of object

namestringrequired

valuestringrequired

eventsobject[]required

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

Allowed:draftededitedscheduledcanceleddiscardedqueuedreplayedsentdelivereddeferredbouncedcomplainedfailed

atstring<date-time>required

recipientstring<email> | nullrequired

Show properties

Any of:

string<email>

string<email>

null

null

detailstring | nullrequired

Show properties

Any of:

string

string

null

null

engagementsobject[]required

Show properties

Array of object

kindstringrequired

Allowed:openclick

atstring<date-time>required

urlstring<uri> | nullrequired

Show properties

Any of:

string<uri>

string<uri>

null

null

user_agentstring | nullrequired

Show properties

Any of:

string

string

null

null

botbooleanrequired

True when a proxy, security scanner or script made the hit rather than the recipient.

bot_reasonstring | nullrequired

Why: privacy_proxy is Apple Mail Privacy Protection fetching on arrival, script an HTTP library, known_bot a scanner or link expander that names itself, stale_browser a browser build nobody runs any more, too_fast within seconds of delivery, sooner than a person could act. Null when bot is false. More reasons may be added; treat one you do not know as a bot.

Show properties

Any of:

string

string

null

null

null

null

categorystring | nullrequired

What kind of mail it is. Gate automated replies on human, or an autoresponder and your agent answer each other.

Show properties

Any of:

string

string

null

null

verdictsobject | nullrequired

Show properties

Any of:

object

spamstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

spfstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

dkimstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

dmarcstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

null

null

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

email_idstringrequired

The email, eml_…. Retrieve it for bodies and headers.

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

The conversation it belongs to.

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | nullrequired

The domain the message went through: received on or sent from. Null when it went through a mailbox.

Show properties

Any of:

string

string

null

null

mailbox_idstring | nullrequired

The mailbox the message went through: synced from or sent with. Null when it went through a domain.

Show properties

Any of:

string

string

null

null

fromstring<email>required

The sender.

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

tostring<email>[]required

The recipients on the envelope.

subjectstringrequired

The subject line.

snippetstringrequired

A short preview of the body.

attachmentsobject[]

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

filenamestringrequired

content_typestringrequired

sizeintegerrequired

min 0 · max 9007199254740991

preparationstringrequired

Allowed:readypartialunsupportedfailed

emailobject | null

Show properties

Any of:

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

directionstringrequired

Allowed:inboundoutbound

statusstringrequired

Allowed:draftscheduledcanceleddiscardedqueuedsendingsentdeliveredbouncedcomplainedfailedreceived

fromobjectrequired

Show properties

namestring | null

Show properties

Any of:

string

string

null

null

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

tostring<email>[]required

ccstring<email>[]required

bccstring<email>[]required

reply_tostring<email>[]required

subjectstringrequired

snippetstringrequired

htmlstring | nullrequired

Show properties

Any of:

string

string

null

null

textstring | nullrequired

Show properties

Any of:

string

string

null

null

categorystring | nullrequired

Show properties

Any of:

string

string

null

null

verdictsobject | nullrequired

Show properties

Any of:

object

spamstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

spfstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

dkimstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

dmarcstring | nullrequired

PASS, FAIL, GRAY or PROCESSING_FAILED. Null when this check was not reported.

Show properties

Any of:

string

string

null

null

null

null

suppression_keystring | nullrequired

Show properties

Any of:

string

string

null

null

message_idstringrequired

The RFC Message-ID, without angle brackets.

in_reply_tostring | nullrequired

The Message-ID of the message this one answers, without angle brackets. Null when it answers none.

Show properties

Any of:

string

string

null

null

idempotency_keystring | nullrequired

Show properties

Any of:

string

string

null

null

created_atstring<date-time>required

When it took its place in its thread. A draft's moves to when it is sent — draft.drafted_at keeps when it was written.

scheduled_atstring<date-time> | nullrequired

Show properties

Any of:

string<date-time>

string<date-time>

null

null

sent_atstring<date-time> | nullrequired

Show properties

Any of:

string<date-time>

string<date-time>

null

null

draftobject | nullrequired

Show properties

Any of:

object

drafted_atstring<date-time>required

edited_atstring<date-time> | nullrequired

When its content last changed before it was sent. Null when it went as written.

Show properties

Any of:

string<date-time>

string<date-time>

null

null

review_urlstring<uri> | nullrequired

Where a person reviews, edits and sends it in the console.

Show properties

Any of:

string<uri>

string<uri>

null

null

null

null

attachmentsobject[]required

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

filenamestringrequired

content_typestringrequired

sizeintegerrequired

min 0 · max 9007199254740991

cidstring | nullrequired

Show properties

Any of:

string

string

null

null

download_urlstring<uri> | nullrequired

Show properties

Any of:

string<uri>

string<uri>

null

null

expires_atstring<date-time> | nullrequired

When download_url and preparation.content_url stop working — an hour after the response. Read the email again, or call the download endpoint with the attachment ID, for fresh ones.

Show properties

Any of:

string<date-time>

string<date-time>

null

null

preparationobject | nullrequired

Show properties

Any of:

object

statusstringrequired

Allowed:readypartialunsupportedfailed

formatstring | nullrequired

Show properties

Any of:

string

string

null

null

pagesinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

warningsstring[]required

content_urlstring<uri> | nullrequired

Show properties

Any of:

string<uri>

string<uri>

null

null

textstring | null

Show properties

Any of:

string

string

null

null

null

null

stripped_textstring | nullrequired

What this message says: typed text only, quoted conversation and signature removed. A signature the thread has not seen from this sender stays — it is where the name and role are.

Show properties

Any of:

string

string

null

null

stripped_htmlstring | nullrequired

Show properties

Any of:

string

string

null

null

segmentsobject[]required

Show properties

Array of object

kindstringrequired

Allowed:writtenquotedsignature

textstringrequired

referencesstring[]required

The Message-IDs of the conversation so far, oldest first, without angle brackets.

headersobject[]required

Show properties

Array of object

namestringrequired

valuestringrequired

eventsobject[]required

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

Allowed:draftededitedscheduledcanceleddiscardedqueuedreplayedsentdelivereddeferredbouncedcomplainedfailed

atstring<date-time>required

recipientstring<email> | nullrequired

Show properties

Any of:

string<email>

string<email>

null

null

detailstring | nullrequired

Show properties

Any of:

string

string

null

null

engagementsobject[]required

Show properties

Array of object

kindstringrequired

Allowed:openclick

atstring<date-time>required

urlstring<uri> | nullrequired

Show properties

Any of:

string<uri>

string<uri>

null

null

user_agentstring | nullrequired

Show properties

Any of:

string

string

null

null

botbooleanrequired

True when a proxy, security scanner or script made the hit rather than the recipient.

bot_reasonstring | nullrequired

Show properties

Any of:

string

string

null

null

null

null

suppression_keystring | nullrequired

The suppression list the send named, when it named one.

Show properties

Any of:

string

string

null

null

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

email_idstringrequired

The email, eml_…. Retrieve it for bodies and headers.

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

The conversation it belongs to.

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | nullrequired

The domain the message went through: received on or sent from. Null when it went through a mailbox.

Show properties

Any of:

string

string

null

null

mailbox_idstring | nullrequired

The mailbox the message went through: synced from or sent with. Null when it went through a domain.

Show properties

Any of:

string

string

null

null

suppression_keystring | nullrequired

The suppression list the send named, when it named one.

Show properties

Any of:

string

string

null

null

recipientsstring<email>[]required

Which recipients this event covers: delivery is reported per recipient.

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

email_idstringrequired

The email, eml_…. Retrieve it for bodies and headers.

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

The conversation it belongs to.

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | nullrequired

The domain the message went through: received on or sent from. Null when it went through a mailbox.

Show properties

Any of:

string

string

null

null

mailbox_idstring | nullrequired

The mailbox the message went through: synced from or sent with. Null when it went through a domain.

Show properties

Any of:

string

string

null

null

suppression_keystring | nullrequired

The suppression list the send named, when it named one.

Show properties

Any of:

string

string

null

null

recipientsstring<email>[]required

Which recipients bounced.

permanentbooleanrequired

True for a hard bounce: the address does not exist. False for a soft one: a full mailbox, a temporary failure.

reasonstringrequired

What the receiving server said.

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

email_idstringrequired

The email, eml_…. Retrieve it for bodies and headers.

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

The conversation it belongs to.

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | nullrequired

The domain the message went through: received on or sent from. Null when it went through a mailbox.

Show properties

Any of:

string

string

null

null

mailbox_idstring | nullrequired

The mailbox the message went through: synced from or sent with. Null when it went through a domain.

Show properties

Any of:

string

string

null

null

suppression_keystring | nullrequired

The suppression list the send named: where the complaint is filed, in the send's space.

Show properties

Any of:

string

string

null

null

recipientsstring<email>[]required

Who complained.

reasonstring | nullrequired

The provider's reason, when it gave one.

Show properties

Any of:

string

string

null

null

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

email_idstringrequired

The email, eml_…. Retrieve it for bodies and headers.

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

The conversation it belongs to.

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | nullrequired

The domain the message went through: received on or sent from. Null when it went through a mailbox.

Show properties

Any of:

string

string

null

null

mailbox_idstring | nullrequired

The mailbox the message went through: synced from or sent with. Null when it went through a domain.

Show properties

Any of:

string

string

null

null

suppression_keystring | nullrequired

The suppression list the send named, when it named one.

Show properties

Any of:

string

string

null

null

reasonstringrequired

What the provider said: why the message never went out.

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

email_idstringrequired

The message they opted out from, eml_….

matches ^[a-z]+_[0-9a-f]{32}$

message_idstring | nullrequired

The RFC Message-ID, without angle brackets. Null once the message is gone.

Show properties

Any of:

string

string

null

null

domain_idstring | nullrequired

The domain the message went through: received on or sent from. Null when it went through a mailbox.

Show properties

Any of:

string

string

null

null

mailbox_idstring | nullrequired

The mailbox the message went through: synced from or sent with. Null when it went through a domain.

Show properties

Any of:

string

string

null

null

addressstring<email>required

Who opted out.

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

keystringrequired

The suppression list. * is the whole workspace's, or the whole space's when the send was from one.

scopestringrequired

Whether they blocked everything (all) or only optional mail (optional).

Allowed:alloptional

sourcestringrequired

How: the unsubscribe link, the mail client's one-click header, or a reply that read as an opt-out.

Allowed:linkone_clickreply

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

email_idstringrequired

The email, eml_…. Retrieve it for bodies and headers.

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

The conversation it belongs to.

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | nullrequired

The domain the message went through: received on or sent from. Null when it went through a mailbox.

Show properties

Any of:

string

string

null

null

mailbox_idstring | nullrequired

The mailbox the message went through: synced from or sent with. Null when it went through a domain.

Show properties

Any of:

string

string

null

null

suppression_keystring | nullrequired

The suppression list the send named, when it named one.

Show properties

Any of:

string

string

null

null

user_agentstring | nullrequired

The client that loaded the tracking pixel.

Show properties

Any of:

string

string

null

null

botbooleanrequired

True when a proxy, security scanner or script made the hit rather than the recipient.

bot_reasonstring | nullrequired

Show properties

Any of:

string

string

null

null

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

email_idstringrequired

The email, eml_…. Retrieve it for bodies and headers.

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

The conversation it belongs to.

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | nullrequired

The domain the message went through: received on or sent from. Null when it went through a mailbox.

Show properties

Any of:

string

string

null

null

mailbox_idstring | nullrequired

The mailbox the message went through: synced from or sent with. Null when it went through a domain.

Show properties

Any of:

string

string

null

null

suppression_keystring | nullrequired

The suppression list the send named, when it named one.

Show properties

Any of:

string

string

null

null

urlstring<uri>required

The destination that was clicked.

user_agentstring | nullrequired

The client that followed the link.

Show properties

Any of:

string

string

null

null

botbooleanrequired

True when a proxy, security scanner or script made the hit rather than the recipient.

bot_reasonstring | nullrequired

Show properties

Any of:

string

string

null

null

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

thread_idstringrequired

The new conversation, thr_….

matches ^[a-z]+_[0-9a-f]{32}$

subjectstringrequired

The opening subject.

mailboxstring<email>required

The address on your side.

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

forward_ofstring | nullrequired

Set when a forward opened the thread: the conversation it carries.

Show properties

Any of:

string

string

null

null

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

domain_idstringrequired

The domain, dom_….

matches ^[a-z]+_[0-9a-f]{32}$

namestringrequired

The domain name.

regionstringrequired

The region it sends and receives in.

Allowed:eu-central-1us-east-1

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

domain_idstringrequired

The domain, dom_….

matches ^[a-z]+_[0-9a-f]{32}$

namestringrequired

The domain name.

regionstringrequired

The region it sends and receives in.

Allowed:eu-central-1us-east-1

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

mailbox_idstringrequired

The mailbox, mbx_….

matches ^[a-z]+_[0-9a-f]{32}$

addressstring<email>required

The mailbox address.

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

providerstringrequired

Which provider hosts the mailbox.

Allowed:googlemicrosoft

refstring | nullrequired

The mailbox's ref: what you put on the connect link or passed to mailboxes.connect. How you match the mailbox to your user.

Show properties

Any of:

string

string

null

null

metadataobjectrequired

Your own key-value pairs, stored and given back as they are. Up to 50 keys; a key is 1–40 characters, a value up to 500. Written whole: what you send replaces what was there.

app_idstring | nullrequired

The OAuth app of yours the mailbox was connected through.

Show properties

Any of:

string

string

null

null

reconnectedbooleanrequired

True when this replaced an existing authorization rather than adding a new mailbox.

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

mailbox_idstringrequired

The mailbox, mbx_….

matches ^[a-z]+_[0-9a-f]{32}$

addressstring<email>required

The mailbox address.

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

providerstringrequired

Which provider hosts the mailbox.

Allowed:googlemicrosoft

refstring | nullrequired

The mailbox's ref: what you put on the connect link or passed to mailboxes.connect. How you match the mailbox to your user.

Show properties

Any of:

string

string

null

null

metadataobjectrequired

Your own key-value pairs, stored and given back as they are. Up to 50 keys; a key is 1–40 characters, a value up to 500. Written whole: what you send replaces what was there.

reasonstring | nullrequired

What the provider said, when it said anything.

Show properties

Any of:

string

string

null

null

object

idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

When the event happened.

space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

null

null

dataobjectrequired

Show properties

mailbox_idstringrequired

The mailbox, mbx_….

matches ^[a-z]+_[0-9a-f]{32}$

addressstring<email>required

The mailbox address.

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

providerstringrequired

Which provider hosts the mailbox.

Allowed:googlemicrosoft

refstring | nullrequired

The mailbox's ref: what you put on the connect link or passed to mailboxes.connect. How you match the mailbox to your user.

Show properties

Any of:

string

string

null

null

metadataobjectrequired

Your own key-value pairs, stored and given back as they are. Up to 50 keys; a key is 1–40 characters, a value up to 500. Written whole: what you send replaces what was there.

reasonstring | nullrequired

What the provider said, when it said anything.

Show properties

Any of:

string

string

null

null

400

The request is invalid.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

401

The API key is missing or invalid.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

402

The workspace has no plan (plan_required), or its plan's allowance is used up (allowance_reached).

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

403

The API key or token does not have the required scope, or the token is connected as an inbox and the operation is not one an inbox may use.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

404

The requested resource does not exist.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

409

The request conflicts with the resource's current state.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

413

The request body or attachments are too large.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

415

The request body is not JSON.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

422

The request body failed validation.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

429

The organisation's request budget is spent (too_many_requests), or an upstream mail provider is throttling (rate_limited).

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

500

An internal error occurred.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

502

An upstream mail provider failed.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

503

The service is temporarily unavailable.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

Request

import AIInbx from "aiinbx"

const aiinbx = new AIInbx()

const response = await aiinbx.events.retrieve(
  "evt_0192a3b4c5d67890abcdef1234567890"
)

from aiinbx import AIInbx

with AIInbx() as client:
    response = client.events.retrieve("evt_0192a3b4c5d67890abcdef1234567890")

curl -X GET 'https://api.aiinbx.com/api/v2/events/evt_0192a3b4c5d67890abcdef1234567890' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Response

{
  "id": "string",
  "type": "email.received",
  "created_at": "2019-08-24T14:15:22Z",
  "space_id": "string",
  "data": {
    "email_id": "string",
    "message_id": "string",
    "thread_id": "string",
    "domain_id": "string",
    "mailbox_id": "string",
    "from": "user@example.com",
    "to": [
      "user@example.com"
    ],
    "subject": "string",
    "snippet": "string",
    "attachments": [
      {
        "id": "string",
        "filename": "string",
        "content_type": "string",
        "size": 0,
        "preparation": "ready"
      }
    ],
    "email": {
      "id": "string",
      "thread_id": "string",
      "space_id": "string",
      "direction": "inbound",
      "status": "draft",
      "from": {
        "name": "string",
        "address": "user@example.com"
      },
      "to": [
        "user@example.com"
      ],
      "cc": [
        "user@example.com"
      ],
      "bcc": [
        "user@example.com"
      ],
      "reply_to": [
        "user@example.com"
      ],
      "subject": "string",
      "snippet": "string",
      "html": "string",
      "text": "string",
      "category": "human",
      "verdicts": {
        "spam": "string",
        "spf": "string",
        "dkim": "string",
        "dmarc": "string"
      },
      "suppression_key": "string",
      "message_id": "string",
      "in_reply_to": "string",
      "idempotency_key": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "scheduled_at": "2019-08-24T14:15:22Z",
      "sent_at": "2019-08-24T14:15:22Z",
      "draft": {
        "drafted_at": "2019-08-24T14:15:22Z",
        "edited_at": "2019-08-24T14:15:22Z",
        "review_url": "http://example.com"
      },
      "attachments": [
        {
          "id": "string",
          "filename": "string",
          "content_type": "string",
          "size": 0,
          "cid": "string",
          "download_url": "http://example.com",
          "expires_at": "2019-08-24T14:15:22Z",
          "preparation": {
            "status": "ready",
            "format": "markdown",
            "pages": -9007199254740991,
            "warnings": [
              "string"
            ],
            "content_url": "http://example.com",
            "text": "string"
          }
        }
      ],
      "stripped_text": "string",
      "stripped_html": "string",
      "segments": [
        {
          "kind": "written",
          "text": "string"
        }
      ],
      "references": [
        "string"
      ],
      "headers": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "events": [
        {
          "id": "string",
          "type": "drafted",
          "at": "2019-08-24T14:15:22Z",
          "recipient": "user@example.com",
          "detail": "string"
        }
      ],
      "engagements": [
        {
          "kind": "open",
          "at": "2019-08-24T14:15:22Z",
          "url": "http://example.com",
          "user_agent": "string",
          "bot": true,
          "bot_reason": "privacy_proxy"
        }
      ]
    },
    "category": "human",
    "verdicts": {
      "spam": "string",
      "spf": "string",
      "dkim": "string",
      "dmarc": "string"
    }
  }
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}