Skip to main content
POST
/
v1
/
alarms
/
{id}
/
trigger
Trigger Alarm Evaluation
curl --request POST \
  --url https://api.bland.ai/v1/alarms/{id}/trigger \
  --header 'authorization: <authorization>'
{
  "data": {
    "success": true,
    "message": "Test completed successfully. Current alarm state: NORMAL",
    "currentMetrics": {
      "value": 0.2,
      "sampleCount": 22,
      "deviation": null,
      "threshold": 2.5
    }
  },
  "errors": null
}

​
Headers

​
authorization
string
required
Your API key for authentication.

​
Path Parameters

​
id
string
required
Alarm configuration ID.

​
Response

​
data.success
boolean
Whether the evaluation completed with enough data.
​
data.message
string
Human-readable result message.
​
data.currentMetrics
object
Current metric snapshot, when available.
​
data.currentMetrics.value
number
Current metric value.
​
data.currentMetrics.sampleCount
number
Number of samples used in evaluation.
​
data.currentMetrics.deviation
number|null
Deviation from baseline.
​
data.currentMetrics.threshold
number
Configured threshold for comparison.
{
  "data": {
    "success": true,
    "message": "Test completed successfully. Current alarm state: NORMAL",
    "currentMetrics": {
      "value": 0.2,
      "sampleCount": 22,
      "deviation": null,
      "threshold": 2.5
    }
  },
  "errors": null
}