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>"
}
'import requests
url = "https://api.bland.ai/v1/alarms/{id}/notify"
payload = { "type": "<string>" }
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({type: '<string>'})
};
fetch('https://api.bland.ai/v1/alarms/{id}/notify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bland.ai/v1/alarms/{id}/notify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bland.ai/v1/alarms/{id}/notify"
payload := strings.NewReader("{\n \"type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bland.ai/v1/alarms/{id}/notify")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/alarms/{id}/notify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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
}
{
"data": null,
"errors": [
{
"error": "INVALID_NOTIFICATION_TYPE",
"message": "type must be either 'alarm' or 'recovery'"
}
]
}
Alarms
Test Alarm Notifications
Send a test alarm or recovery notification.
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>"
}
'import requests
url = "https://api.bland.ai/v1/alarms/{id}/notify"
payload = { "type": "<string>" }
headers = {
"authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({type: '<string>'})
};
fetch('https://api.bland.ai/v1/alarms/{id}/notify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bland.ai/v1/alarms/{id}/notify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bland.ai/v1/alarms/{id}/notify"
payload := strings.NewReader("{\n \"type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bland.ai/v1/alarms/{id}/notify")
.header("authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v1/alarms/{id}/notify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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
}
{
"data": null,
"errors": [
{
"error": "INVALID_NOTIFICATION_TYPE",
"message": "type must be either 'alarm' or 'recovery'"
}
]
}
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.{
"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
}
{
"data": null,
"errors": [
{
"error": "INVALID_NOTIFICATION_TYPE",
"message": "type must be either 'alarm' or 'recovery'"
}
]
}
Docs for agents: llms.txt
Was this page helpful?
⌘I