Send events
The Send events endpoints show what happened to every message you send through Transactional send and Agent Accounts: accepted, delivered, bounced, marked as spam, or rejected, for each recipient.
Use them to:
- Find out why a message didn't reach a recipient, with the bounce reason and the response from the recipient's mail server.
- Track your delivery, bounce, and complaint rates over time, and get a health grade for the last 7 days.
- Find which sending domain, Agent Account, or recipient domain is causing bounces or complaints.
For real-time events, use webhooks. These endpoints are for reviewing patterns and trends over time, and for debugging the delivery of individual messages after they're sent. They aren't for following each message as it happens. Avoid polling them for new events. The delivered, bounced, complaint, and rejected events are the same outcomes that the Agent Account notifications (message.delivered, message.bounced, message.complaint, message.rejected) and the Transactional send notifications (message.transactional.*) report. Subscribe to those to act on each message, and use Send alerts to find out when a rate crosses a threshold. See Use webhooks for real-time events.
Events are kept for 90 days, and metrics cover up to a year. Sends from connected grants (Google, Microsoft, and other providers) aren't included. These endpoints use your application's API key.
For examples, see Monitor delivery and engagement.
GET /v3/activity/sendReturns 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 messag...
GET /v3/activity/send/{event_id}Returns one send event by its ID, such as an event you received earlier from the list endpoint.
GET /v3/activity/send/messages/{message_id}Returns the delivery timeline of one message for each of its recipients: when Nylas accepted it, and whether it was delivered, bounced, marked as spam, or rejected. Use it to check whether a message r...
GET /v3/metrics/send/summaryReturns your delivery, bounce, and complaint rates for a date window, compared with the previous window of the same length, plus an overall health grade for the last 7 days. When health is at risk or...
GET /v3/metrics/send/timeseriesReturns sent, delivered, bounced, and complaint counts with bounce and complaint rates, bucketed by day, week, or month. Use it to chart how your sending changes over a date range and to spot the day...
GET /v3/metrics/sendReturns send counts and rates grouped by sending domain, sender address, or recipient domain. Use it to find which of your domains or Agent Accounts has the highest bounce rate, or which mailbox provi...