Skip to main content
POST
/
v1
/
alarms
/
{id}
/
notify
Test Alarm Notifications
curl --request POST \
  --url https://api.bland.ai/v1/alarms/{id}/notify \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "type": "<string>"
}
'
{
  "data": {
    "success": true,
    "message": "Alarm notification test completed: 2/2 methods successful",
    "results": {
      "webhook": {
        "success": true,
        "statusCode": 200
      },
      "email": {
        "success": true,
        "sentTo": ["alerts@example.com"]
      }
    }
  },
  "errors": null
}

​
Headers

​
authorization
string
required
Your API key for authentication.

​
Path Parameters

​
id
string
required
Alarm configuration ID.

​
Body Parameters

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

​
Response

​
data.success
boolean
Whether at least one configured delivery method succeeded.
​
data.message
string
Summary of the test result.
​
data.results
object
Delivery results by channel (webhook, email, sms).
​
data.results.webhook.success
boolean
Whether webhook delivery succeeded.
​
data.results.webhook.statusCode
number
HTTP status returned by the webhook endpoint, when available.
​
data.results.email.success
boolean
Whether email delivery succeeded.
​
data.results.email.sentTo
string[]
Recipient list used for the test email.
​
errors
null|array
null on success response, or an array with NOTIFICATION_TEST_FAILED.
{
  "data": {
    "success": true,
    "message": "Alarm notification test completed: 2/2 methods successful",
    "results": {
      "webhook": {
        "success": true,
        "statusCode": 200
      },
      "email": {
        "success": true,
        "sentTo": ["alerts@example.com"]
      }
    }
  },
  "errors": null
}