Skip to main content
POST
Create Alarm

Headers

authorization
string
required
Your API key for authentication.

Body Parameters

metric_type
string
required
Metric to monitor. Allowed values: latency, api_errors, call_length.
threshold
number
required
Positive numeric threshold used for alarm trigger evaluation.Notes:
  • threshold is a sensitivity scalar (higher values are less sensitive; lower values are more sensitive).
  • The Dashboard may display an approximate ”% change” visualization for this value. Treat that UI percentage as a directional aid, not an exact conversion.
Dashboard sensitivity presets map to these threshold values:
  • Sensitive0.5
  • Normal1.0
  • Relaxed2.0
  • Critical2.5
webhook_config
object
Optional webhook destination for alarm notifications.webhook_config should be a JSON object with:
  • url (string, required)
  • headers (object, optional)
Example:
email_addresses
string[]
Optional email recipients for notifications.
sms_numbers
string[]
Optional SMS recipients for notifications.

Response

data.alarm
object
Created alarm configuration object.
data.alarm.id
string
Alarm configuration ID.
data.alarm.metric_type
string
Metric tracked by this alarm.
data.alarm.threshold
number
Configured trigger threshold.
data.alarm.enabled
boolean
Whether this alarm is enabled.
errors
null|array
null on success, otherwise an array of error objects.

Docs for agents: llms.txt