Skip to main content
Version: Next

Alarm

Operational alarm submitted to or returned by the alarm service.

assigneeIdstring

Identity-provider user assigned to handle the alarm.

Example: 2f1c17e5-72b8-4dbe-9f8d-c49e66f82e10
contentstring

Detailed alarm message.

Example: Boiler room temperature reached 42 °C.
realmstringrequired

Realm that owns the alarm.

Example: building
severitystringrequired

Operational impact of the alarm.

Possible values: [LOW, MEDIUM, HIGH]

sourcestringrequired

Kind of actor that created the alarm.

Possible values: [MANUAL, CLIENT, GLOBAL_RULESET, REALM_RULESET, ASSET_RULESET, AGENT]

sourceIdstringrequired

Identifier of the rule, user, or system component that created the alarm.

statusstringrequired

Current alarm workflow state.

Possible values: [OPEN, ACKNOWLEDGED, IN_PROGRESS, RESOLVED, CLOSED]

titlestringrequired

Short human-readable alarm title.

Example: Temperature threshold exceeded
Alarm
{
"assigneeId": "2f1c17e5-72b8-4dbe-9f8d-c49e66f82e10",
"content": "Boiler room temperature reached 42 °C.",
"realm": "building",
"severity": "LOW",
"source": "MANUAL",
"sourceId": "string",
"status": "OPEN",
"title": "Temperature threshold exceeded"
}