Alerts / Test

Send a test alert through an existing alert channel on your account. Use the same channel_key values returned by /alerts/list and accepted in monitor and heartbeat alert_channel_keys.

Endpoint

Method POST
Url https://downdar.com/api/v1/alerts/test

Request

Key fields

channel_key key Alert channel key. Built-in email is email; custom channels use {type}:{guid} (for example discord:550e8400-e29b-41d4-a716-446655440000).
event_kind key down or up.
{ "channel_key": "discord:550e8400-e29b-41d4-a716-446655440000", "event_kind": "down" }

Response

Top level

ok Always true on success.
alert_test Test delivery result. Fields below apply to alert_test.
capacity Alert channel quota for the account.
rate_limit Rate limit state for the tier this endpoint consumes. Present on every successful response.

alert_test

channel_key Alert channel key that was tested.
event_kind Echoes the requested event kind: down or up.
message Human-readable success message.
http_status HTTP status from the remote endpoint when applicable. Email tests return 202 when queued.

capacity

limit Maximum alert channels allowed on your plan.
used Alert channels currently in use.
remaining Alert channels you can still create.

rate_limit

tier Rate tier this endpoint counts against (1-5).
cost Units consumed by this request against the tier window.
timeframe Rolling limit window: second, minute, hour, or day.
limit Maximum units allowed in the timeframe for this tier on your plan.
used Units already used in the current window.
remaining Units left before this tier returns HTTP 429.
{ "ok": true, "alert_test": { "channel_key": "discord:550e8400-e29b-41d4-a716-446655440000", "event_kind": "down", "message": "Test alert sent.", "http_status": 204 }, "capacity": { "limit": 10, "used": 1, "remaining": 9 }, "rate_limit": { "tier": 5, "cost": 1, "timeframe": "minute", "limit": 5, "used": 1, "remaining": 4 } }