Alerts
Alerts are runtime records created when policies trigger.
Alerts API
See the exact alert routes, status filtering, delivery queries, and transition responses.
Destinations
Configure where alerts are sent, run destination tests, and inspect delivery history correctly.
Alert reads and lifecycle actions
GET /v1.0/alerts— list alerts, optionally filter with?status=triggeredGET /v1.0/alerts/:alertID— read one alertGET /v1.0/alerts/:alertID/deliveries— read delivery attemptsPOST /v1.0/alerts/:alertID/acknowledge— mark as seenPOST /v1.0/alerts/:alertID/resolve— mark as resolvedPOST /v1.0/alerts/:alertID/archive— move out of active views
Alert lifecycle
triggered → acknowledged → resolved → archived| Status | Meaning | Typical action |
|---|---|---|
triggered | Policy threshold breached. Delivery is pending or complete. | Investigate the cause. |
acknowledged | An operator has seen the alert. | Work on a fix. |
resolved | The issue has been addressed. | Verify the fix holds. |
archived | Alert is closed. | No further action needed. |
What an alert contains
Each alert records the policy state at trigger time:
policy_id,event_id— which policy and eventperiod,aggregate,condition,threshold— the rule that firedseverity— the policy’s severity levelvalue— the aggregated value that crossed the thresholdcount,min,max— rollup stats from the triggering buckettriggered_at— when the policy evaluated and fired
Delivery investigation
After an alert is triggered, Chirpier delivers it to matching destinations. Each delivery attempt is recorded with:
| Field | Description |
|---|---|
channel | Destination type (slack, discord, telegram, webhook, email) |
target | Where it was sent (URL, email address, etc.) |
status | sent or failed |
response_status | HTTP status code from the downstream provider |
error_message | Error details if delivery failed |
created_at | When the attempt was made |
Use delivery history to answer:
- Was the alert routed to any destination?
- Did the downstream provider accept the delivery?
- What HTTP status or error came back?
- Was a test send successful?
Filter delivery reads with:
kind=alert— real alert deliverieskind=test— destination test deliverieskind=all— both, for debugging
Use kind=test immediately after testing a destination to verify the send succeeded.
For delivery target configuration, continue with Destinations.
Last updated on