Return a send event - Send Events - API Reference

GET

https://api.us.nylas.com/v3/activity/send/{event_id}

Returns one send event by its ID, such as an event you received earlier from the list endpoint.

NYLAS API KEY

Parameters

Path parameters

event_id*string

The ID of the event, as returned in the event's id field.

Example: "1110f3b5fa7cc381421942082f1e8c8fe2b85f0072b6c67b123a2bf4d8286848"

Responses

request_idstring

The request ID.

dataobject

One thing that happened to a message for one recipient.

idstring

The ID of the event.

Example: "1110f3b5fa7cc381421942082f1e8c8fe2b85f0072b6c67b123a2bf4d8286848"

event_typestring

What happened. accepted means Nylas accepted the message for delivery. delivered means the recipient's mail server accepted it. bounced means it wasn't delivered. complaint means the recipient marked it as spam. rejected means Nylas didn't send it because of bad content.

accepteddeliveredbouncedcomplaintrejected

Example: "bounced"

bounce_classstring

For a bounce, whether it's permanent (hard), temporary (soft), or unclassified (undetermined). Stop sending to addresses that hard-bounce.

hardsoftundetermined

Example: "hard"

timestampinteger<int64>

When the event happened, as a Unix timestamp in seconds.

Example: 1792785245

application_idstring

The ID of your Nylas application.

Example: "26302083-12ae-4f38-91fe-6cba93da03ee"

grant_idstring

The Agent Account grant that sent the message. Empty for a transactional send.

Example: "0b7e5a6b-0cbd-4a39-b3ba-2b53b1b0a7d6"

message_idstring

The ID of the message. For a transactional send, this is the message's Message-ID header.

Example: "5a8f7b2e-3c1d-4e9f-8a6b-2d4c6e8f0a1b"

thread_idstring

The Agent Account thread the message belongs to. Empty for a transactional send.

Example: "9c3e1f7a-6b2d-4a8e-b5c4-1e7d3a9f2b6c"

fromstring

The email address the message was sent from.

Example: "[email protected]"

sending_domainstring

The domain the message was sent from.

Example: "mail.example.com"

recipientstring

The recipient's email address.

Example: "[email protected]"

recipient_domainstring

The recipient's domain.

Example: "example.org"

subjectstring

The message subject.

Example: "Your order has shipped"

reasonstring

A short summary of why the event happened, such as the bounce subtype and status code, the SMTP response for a delivery, or the feedback type for a complaint. Empty for accepted.

Example: "General (5.1.1)"

detailobject

Delivery details reported by the recipient's mail server. Only the fields that apply to the event are included.