API Reference
Alerts
Configure alert rules to get notified when deliverability scores drop below thresholds or other conditions are met.
Create a new alert rule. Alerts can trigger based on score thresholds, authentication failures, or other conditions.
Request Bodyrequired
namestringrequiredDisplay name for the alert rule
conditionstringrequiredCondition that triggers the alert
score_belowauth_failblocklist_hitthresholdintegerScore threshold (0-100) for score_below condition
channelsarrayrequiredNotification channels
emailwebhookslackenabledbooleanWhether the alert is active (default: true)
Response
idstringUnique alert ID (alt_xxx)
objectstringAlways 'alert'
namestringconditionstringthresholdintegerchannelsarrayenabledbooleancreated_atstring<date-time>Example Request
curl -X POST https://api.reachscore.co/v1/alerts \
-H "Authorization: Bearer rk_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"name": "Low Score Alert",
"condition": "score_below",
"threshold": 70,
"channels": ["email", "webhook"]
}'Example Response
{
"id": "alt_6bL1oP5qSuV7",
"object": "alert",
"name": "Low Score Alert",
"condition": "score_below",
"threshold": 70,
"channels": ["email", "webhook"],
"enabled": true,
"created_at": "2026-03-11T10:30:00Z"
}