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
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-lumen |
| Version | 1.0 |
Input Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | string | Yes | — | Org scope; engine-injected, never from request body. |
alert_rule_uuid | string | Yes | — | Public UUID of the alert rule to update. |
project | string | No | — | Project name or glob pattern the rule matches. |
event_type | string | No | — | Trigger event: new_group, regressed, or threshold. |
min_occurrences | integer | No | — | Minimum occurrence count before the rule fires. |
level_filter | string | No | — | Comma-separated log levels that may trigger the rule, e.g. ERROR,CRITICAL. |
channel | string | No | — | Delivery channel: webhook, slack, or email. |
webhook_url | string | No | — | HTTPS URL; required when channel is webhook or slack. |
recipient | string | No | — | Alert destination address when channel is email. Mapped to Lumen's email_to on the wire. |
secret | string | No | — | HMAC-SHA256 signing secret for webhook and slack channels. |
enabled | boolean | No | — | Whether the rule is active. |
workflow_run_id | string | No | — | Engine-stamped when launched as a child step inside a DAG. |
Output Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
alert_rule_uuid | string | No | — | Public UUID of the updated alert rule. |
channel | string | No | — | — |
event_type | string | No | — | — |
project | string | No | — | — |
level_filter | string | No | — | — |
enabled | boolean | No | — | — |
updated_at | string | No | — | ISO 8601 update timestamp. |
updated_fields | list | No | — | Names of the fields that were sent in the patch. |
reason | string | No | — | — |
http_status | integer | No | — | — |
lumen_error | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram
Transitions
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
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"
}
}