Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

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

Body

application/json

CreateRequest creates a new alert configuration. The kind oneof carries the full specification of the alert; its target and trigger constraints are enforced on the concrete kind messages.

Incident-owner alerts are not created here — turn them on with ToggleIncidentOwnerAlert.

incidentLifecycle
incident_lifecycle · object
required

An incident lifecycle alert.

name
string

Human-readable name for the alert configuration.

Required string length: 1 - 255
fqn
string

User-provided fully qualified name for the alert config. This is a unique identifier that users can specify to reference the alert.

Required string length: 1 - 500
template
template · object

Optional custom template for the rendered alert message. Common to every alert kind; currently applied only to issue alerts.

Response

200 - application/json

Success

CreateResponse returns the created alert configuration.

alert
Alert · object
required

The alert configuration that was created.