List send events
Changed onReturns what happened to your messages, one event per recipient: accepted, delivered, bounced, marked as spam, or rejected. Filter by recipient, message, sender, or event type to find out why a message didn't reach someone, or to list every hard bounce from a sending domain.
Covers transactional and Agent Account sends. Events are kept for 90 days, and the default window is the last 7 days. Results are sorted by event time, newest first.
This endpoint is for looking back at events, not for real-time updates. Avoid polling it for new events. To act on each delivery outcome as it happens, use webhook notifications.
Request
- Base URLhttps://api.us.nylas.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Return only these event types. Repeat the parameter to include more than one.
Return only bounces of this class.
Return only events for this recipient email address.
Return only events for recipients at this domain.
Return only data for messages sent from this domain.
Return only events for messages sent from this email address.
Return only events for messages sent by this Agent Account grant.
Return only events for this message.
Return only events for messages in this Agent Account thread.
Return events at or after this time, as a Unix timestamp in seconds. Defaults to midnight UTC six days ago, so the default window covers the last 7 days. Activity is kept for 90 days, so an earlier value returns events from the last 90 days only.
Return events at or before this time, as a Unix timestamp in seconds. Defaults to the time of the request. Must not be earlier than start.
The sort order of the results by event time. desc returns the newest events first.
The maximum number of objects to return. See Pagination for more information.
An identifier that specifies which page of data to return. You can get this value from the next_cursor response field. See Pagination for more information.
Response
Success. Returns a page of send events.
Example response
{
"request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
"next_cursor": "CigKGjRlaDdyNGQydTFqbWJ0bGo5a2QxdWJtdDZnGAEggIDAu7fw7bEYGg8IABIAGPjh2PGEi_0CIAEiBwgCEOqs6i4="
}Changes
- info
endpoint added
- info