{
"_id": "<string>",
"teamId": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"scopeEntities": [
"<string>"
],
"threshold": 50,
"periodDays": 15,
"channelConfig": {
"email": {
"enabled": true,
"addresses": [
"jsmith@example.com"
]
},
"inapp": {
"enabled": true
},
"webhook": {
"enabled": true
},
"slack": {
"enabled": true
}
},
"enabled": true,
"lastCheckedAt": "2023-11-07T05:31:56Z",
"lastTriggeredAt": "2023-11-07T05:31:56Z",
"recheckDelayHours": 123
}Objects & Definitions
Deliverability alert
A deliverability alert watches one of your warm-up or outreach metrics on a recurring schedule and notifies you when the metric crosses a threshold you defined.
Each alert is identified by the combination of
widget (data source — warmup or outreach), metric, severity, scope, threshold, comparisonOperator, periodDays, periodMode, and scopeEntities. Two alerts with identical values across all of these fields cannot coexist on the same team.
When an alert fires, it notifies you through the channels listed in channelConfig (in-app banner, email, Slack, and/or webhook). To receive webhook callbacks, register a webhook subscribed to the deliverabilityAlertTriggered event with Add Webhook.A deliverability alert configuration. The alert is evaluated periodically against your warm-up or outreach metrics and triggers notifications through the configured channels (in-app, email, webhook, Slack) when the threshold is breached.
Was this page helpful?