Nylas has updated its pricing model.See current pricing on nylas.com →

Command

nylas deliverability send-alerts create

Create a send alert rule.

Written by Qasim Muhammad Staff SRE

What does nylas deliverability send-alerts create do?

The nylas deliverability send-alerts create command adds a rule that fires the alert.triggered webhook when a sending domain's bounce or complaint rate rises above, or delivery rate falls below, a threshold. It covers only messages sent from an Agent Account or through Transactional send; messages from connected grants such as Google or Microsoft accounts are not included. Each application can have at most 20 rules.

Usage

nylas deliverability send-alerts create --metric METRIC --threshold PERCENT --window-hours HOURS [--min-volume N] [--json]

Flags

FlagDescription
--jsonOutput as JSON
--no-colorDisable color output
--verbose(-v)Enable verbose output
--configCustom config file path
--help(-h)Show help for the command
--limitLimit results (most list commands)
--yes(-y)Skip confirmations
--metricMetric: bounce_rate, complaint_rate, delivery_rate (required)
--min-volumeMinimum sends in the window before the rule can fire (default 0)
--thresholdThreshold percent, up to 2 decimals; bounce/complaint fire above it (0 to <100), delivery fires below it (>0 to 100) (required)
--window-hoursLook-back window in hours, 1-24 (required)

Examples

The nylas deliverability send-alerts create command adds a rule that fires the alert.triggered webhook when a sending domain's bounce or complaint rate rises above, or delivery rate falls below, a threshold.

Alert when hard bounces exceed 5% in an hour

nylas deliverability send-alerts create --metric bounce_rate --threshold 5 --window-hours 1 --min-volume 50

Alert when delivery falls below 95% in a day

nylas deliverability send-alerts create --metric delivery_rate --threshold 95 --window-hours 24

Troubleshooting

required flag(s) not set

--metric, --threshold, and --window-hours are required. --min-volume is optional and defaults to 0.

invalid --threshold value

Use a plain percentage with at most 2 decimals, such as 5 or 0.25. bounce_rate and complaint_rate take 0 to under 100; delivery_rate takes over 0 to 100.

an application can have at most 20 alert rules

Delete a rule you no longer need with nylas deliverability send-alerts delete, or change an existing rule with update.

Recommended guides

Run nylas deliverability send-alerts create --help for full help output.