Skip to main content
POST
Create Alarm

Headers

string
required
Your API key for authentication.

Body Parameters

string
required
Metric to monitor. Allowed values: latency, api_errors, call_length.
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
object
Optional webhook destination for alarm notifications.webhook_config should be a JSON object with:
  • url (string, required)
  • headers (object, optional)
Example:
string[]
Optional email recipients for notifications.
string[]
Optional SMS recipients for notifications.

Response

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

Docs for agents: llms.txt