Send alerts - API Reference

The Send alerts endpoints let you know when your Transactional send or Agent Account sending needs attention. Alerts cover those messages only. Messages sent from a connected grant, such as a Google or Microsoft account, aren't included.

Create a rule for your bounce, complaint, or delivery rate, and Nylas checks it every 5 minutes for each of your sending domains. When a domain crosses the threshold, Nylas sends an alert.triggered notification to your webhook.

Use alerts to catch a bad mailing list or a spam complaint spike early, before it hurts your domain's reputation or pauses your sending. Alerts are the way to find out about rate changes without polling the Send events metrics endpoints. An application can have up to 20 rules.

For examples, see Monitor delivery and engagement.

Endpoints

GET

List alert rules

GET /v3/alerts/send

Returns every alert rule in your application, oldest first. An application can have up to 20 rules.

POST

Create an alert rule

POST /v3/alerts/send

Creates a rule that watches the bounce, complaint, or delivery rate of each of your sending domains. Nylas checks every rule every 5 minutes. When a domain's rate over the last window hours crosses th...

GET

Return an alert rule

GET /v3/alerts/send/{rule_id}

Returns the specified alert rule.

PUT

Update an alert rule

PUT /v3/alerts/send/{rule_id}

Updates the specified alert rule. Include only the fields you want to change. Changing a rule starts its alerts over, so a domain that's still past the new threshold gets a new alert.triggered notific...

DELETE

Delete an alert rule

DELETE /v3/alerts/send/{rule_id}

Deletes the specified alert rule. Nylas stops checking it right away.