Skip to main content
POST
Create an alert
Related guide: Alerts guide. See the Alerts guide for a walkthrough with examples.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
display_name
string
required

Workspace-unique display name.

Example:

"High spend on production"

query
object
required

Metric query evaluated on each tick.

condition
object
required

Threshold condition applied to the query result.

description
string

Short human-readable summary of what the alert watches.

project_id
string

Project that owns a project alert. Empty for a workspace alert.

signal
string

UI signal preset the alert is created from. Defaults to custom.

notifier_ids
string[]

Notifiers that receive trigger-open and trigger-resolve notifications.

enabled
boolean

Whether the alert starts evaluating immediately. Defaults to true.

display
object

Display options for the alert activity chart.

scope
enum<string>

Ownership and telemetry evaluation boundary. Unspecified remains a project alert for compatibility with existing clients.

Available options:
ALERT_SCOPE_PROJECT,
ALERT_SCOPE_WORKSPACE

Response

OK

alert
object
required

Newly created alert.