Skip to content
Proud to collaborate with Microsoft for Startups

lumen.alert-rule.create ​

Creates a Lumen alert rule that dispatches webhook, Slack, or email notifications — or opens a native Orkestia incident ticket (channel=ticket) — when fingerprint_log detects a new_group, regressed, or threshold event.

Create a Lumen alert rule (webhook, Slack, email, or ticket) via the Lumen REST API.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-lumen
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes—Org scope; engine-injected, never from request body.
channelstringYes—Delivery channel: webhook, slack, email, or ticket. 'ticket' opens a native Orkestia incident ticket (no destination needed).
webhook_urlstringNo—HTTPS URL; required when channel is webhook or slack. Omit for email or ticket.
recipientstringNo—Alert destination address when channel is email. Mapped to Lumen's email_to on the wire. Omit for webhook, slack, or ticket.
event_typestringNo—Trigger event: new_group, regressed, or threshold. Default: new_group.
projectstringNo—Project name or glob pattern. Default: * (all projects).
level_filterstringNo—Comma-separated log levels that may trigger the rule, e.g. ERROR,CRITICAL.
min_occurrencesintegerNo—Minimum occurrence count before the rule fires. Default: 1.
secretstringNo—HMAC-SHA256 signing secret for webhook and slack channels.
enabledbooleanNo—Whether the rule is active immediately on creation. Default: true.
workflow_run_idstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
alert_rule_uuidstringNo—Public UUID of the created alert rule.
channelstringNo——
event_typestringNo——
projectstringNo——
enabledbooleanNo——
created_atstringNo—ISO 8601 creation timestamp.
reasonstringNo——
http_statusintegerNo——
lumen_errorstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "lumen.alert-rule.create",
  "initial_data": {
    "organization_uuid": "value",
    "channel": "value"
  }
}