Skip to main content
Alerts let you define threshold-based rules that send notifications when an agent or service crosses a condition. Each alert targets either an agent by UUID or a service by name, and delivers notifications over email, webhook, or both.

Alert types

Delivery channels


List alerts

GET /alerts Returns all alerts associated with agents belonging to the authenticated user.

Response — 200

An array of alert objects.
string
Alert UUID.
string | null
UUID of the target agent, or null for service-targeted alerts.
string | null
Name of the target agent, or null.
string
Alert type: failure_rate, inactivity, cost_threshold, latency_threshold, or composite.
number
Threshold value. Semantics depend on the alert type.
number
Minimum minutes between consecutive firings of this alert.
boolean
Whether this alert is currently enabled.
string
Delivery channel: email, webhook, or both.
string | null
Webhook delivery URL. Present when channel is webhook or both.
object | null
Composite rule definition. Present only for composite type alerts.
string | null
Service name for service-targeted alerts. Null for agent-targeted alerts.
string | null
ISO 8601 timestamp of the last time this alert fired.
string
ISO 8601 timestamp when this alert was created.

Create an alert

POST /alerts Creates an alert rule. Either agent_id or target_service must be provided. Validation rules:
  • failure_rate, inactivity, cost_threshold, and latency_threshold alerts require a threshold value.
  • composite alerts require a valid composite_config with at least one ai condition and one infra condition.
  • Alerts with channel of webhook or both require a webhook_url.

Request body

string
UUID of the agent to monitor. Either agent_id or target_service must be provided.
string
Service name to monitor (for infrastructure-only alerts). Either agent_id or target_service must be provided.
string
required
Alert type: failure_rate, inactivity, cost_threshold, latency_threshold, or composite.
number
default:"0"
Threshold value. Required for all types except composite. See the alert types table for semantics.
number
default:"60"
Minimum minutes between consecutive firings of this alert.
string
default:"email"
Delivery channel: email, webhook, or both.
string
HTTPS URL to deliver webhook notifications to. Required when channel is webhook or both.
object
Composite alert rule. Required when type is composite.

Response — 201

Returns the created alert object. Same schema as the list response.

Get an alert

GET /alerts/{alert_id} Returns a single alert. Returns 404 if the alert does not belong to the authenticated user.

Path parameters

string
required
UUID of the alert.

Response — 200

Same schema as a single item from the list response.

Update an alert

PATCH /alerts/{alert_id} Updates one or more mutable fields on an alert. All fields are optional — omit any fields you do not want to change.

Path parameters

string
required
UUID of the alert.

Request body

number
New threshold value.
number
New cooldown period in minutes.
boolean
Set to false to pause the alert, true to re-enable it.
string
New delivery channel: email, webhook, or both.
string
New webhook URL.

Response — 200

Returns the updated alert object.

Delete an alert

DELETE /alerts/{alert_id} Permanently deletes an alert and all its associated events. This action is irreversible.

Path parameters

string
required
UUID of the alert to delete.

Response — 204

No body. The alert has been deleted.