Skip to content
Proud to collaborate with Microsoft for Startups

lumen.alert-rule.update ​

Partially updates a Lumen alert rule by UUID — e.g. correct its level_filter, retarget its project/event_type, or change its delivery channel. Only the fields supplied are changed; the rest are left untouched.

Partially update a Lumen alert rule (by UUID) 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.
alert_rule_uuidstringYes—Public UUID of the alert rule to update.
projectstringNo—Project name or glob pattern the rule matches.
event_typestringNo—Trigger event: new_group, regressed, or threshold.
min_occurrencesintegerNo—Minimum occurrence count before the rule fires.
level_filterstringNo—Comma-separated log levels that may trigger the rule, e.g. ERROR,CRITICAL.
channelstringNo—Delivery channel: webhook, slack, or email.
webhook_urlstringNo—HTTPS URL; required when channel is webhook or slack.
recipientstringNo—Alert destination address when channel is email. Mapped to Lumen's email_to on the wire.
secretstringNo—HMAC-SHA256 signing secret for webhook and slack channels.
enabledbooleanNo—Whether the rule is active.
workflow_run_idstringNo—Engine-stamped when launched as a child step inside a DAG.

Output Schema ​

FieldTypeRequiredDefaultDescription
alert_rule_uuidstringNo—Public UUID of the updated alert rule.
channelstringNo——
event_typestringNo——
projectstringNo——
level_filterstringNo——
enabledbooleanNo——
updated_atstringNo—ISO 8601 update timestamp.
updated_fieldslistNo—Names of the fields that were sent in the patch.
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.update",
  "initial_data": {
    "organization_uuid": "value",
    "alert_rule_uuid": "value"
  }
}