- API reference
- Send alerts
- List alert rules
GET
https://api.us.nylas.com/v3/alerts/sendList alert rules
Returns every alert rule in your application, oldest first. An application can have up to 20 rules.
Works with an API key. IAM API keys can't call this endpoint.
Array items:
Example:
"26302083-12ae-4f38-91fe-6cba93da03ee"metricstringThe rate the rule watches. bounce_rate is hard bounces as a percentage of sent messages,
complaint_rate is complaints as a percentage of delivered messages, and delivery_rate is
delivered messages as a percentage of sent messages.
bounce_ratecomplaint_ratedelivery_rate
Example:
"bounce_rate"directionstringWhether the rule fires when the rate goes above or below the threshold. Set by the metric:
above for bounce_rate and complaint_rate, below for delivery_rate.
abovebelow
Example:
"above"min_volumeintegerThe minimum number of messages a sending domain must send in the window before the rule can fire.
Example:
50Example:
1792785235