Alert definitions service
View and manage your alerts using alert definitions - data structures that contain the configuration required to create an alert.
Overview
View and manage your alerts using alert definitions - data structures that contain the configuration required to create an alert.
Create an alert with an outgoing webhook
This guide demonstrates how to create an alert that sends notifications through an outgoing webhook (e.g., Slack) using the REST API. The flow involves:
Get a list of all accessible alert definitions
Returns all alert definitions for the team.
Replace an alert definition
Updates an existing alert definition.
Create an alert
Creates a new alert definition.
Get counts for filter options
Returns counts for different filter options based on the provided filters
Bulk create alert definitions
Creates multiple alert definitions in a single request. The operation is best-effort - definitions that fail to be created are reported in the response and do not prevent creation of the others. Limited to 100 alert definitions per request.
Bulk delete alert definitions
Delete multiple alert definitions by their IDs. The operation is atomic - either all alerts are deleted or none are. Limited to 100 alert definitions per request.
Download alerts
Download alert definitions in base64-encoded byte format. When ids are provided, only those alert definitions are downloaded; otherwise all accessible alert definitions are downloaded.
Bulk replace alert definitions
Replaces multiple alert definitions in a single request. Each entry updates the existing alert definition with the matching ID; alert definitions not referenced in the request are left unchanged. The operation is best-effort - entries that fail are reported in the response and do not prevent other entries from being applied. Limited to 100 alert definitions per request.
Get alert definition by alert version ID
Returns the alert definition with the specified version ID.
Get alert definition by ID
Returns the details of the specified alert definition.
DeleteAlertDef
Deletes the alert definition with the specified ID.