Skip to main content
POST
Test Alarm Notifications

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
Alarm configuration ID.

Body Parameters

string
required
Notification type to test. Allowed values: alarm, recovery.

Response

boolean
Whether at least one configured delivery method succeeded.
string
Summary of the test result.
object
Delivery results by channel (webhook, email, sms).
boolean
Whether webhook delivery succeeded.
number
HTTP status returned by the webhook endpoint, when available.
boolean
Whether email delivery succeeded.
string[]
Recipient list used for the test email.
null|array
null on success response, or an array with NOTIFICATION_TEST_FAILED.

Docs for agents: llms.txt