Create an alert rule

View as MarkdownOpen in Claude

Creates a new alert rule for the operator’s organisation. Use the catalog endpoint to discover supported event types and recommended defaults. When condition is omitted, the catalog default for the event type is applied.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired

Human-readable name for the rule.

eventTypestringRequired

Event type code the rule listens for. Use the alert-rule catalog endpoint to discover available codes.

conditionobjectOptional

Threshold condition that must evaluate true to fire the alert. Omit to use the event-type’s catalog default.

channelenumOptional

Delivery channel. Defaults to both.

Response

The newly-created alert rule.

dataobject
messagestring

Human-readable acknowledgement.