Skip to main content
Version: 1.0.4

Alarm

Starts a pipeline when an alarm is raised, cleared or acknowledged. It is the front of every notification and escalation flow.

Type: alarm · Category: Realtime · Ports: one input · one output

The Alarm node as it appears on the pipeline canvas.The Alarm node as it appears on the pipeline canvas.

When to use it

  • Notifying someone when a critical alarm is raised
  • Escalating an alarm nobody has acknowledged
  • Logging alarm activity into a reporting database

Settings

SettingKeyDefaultPurpose
Operationoperationsubscribe
Payload modepayloadModeeventEmit the event, or a state summary.
Eventsevents["raised"]raised, cleared, acknowledged.
Prioritiespriorities(all)Filter by priority.
TagstagIds(all)Filter to specific tags.
Include tag metaincludeTagMetafalseAttach the tag's static definition to the event.

Example — critical alarms only

Events: raised
Priorities: critical

Out

{
"payload": {
"alarmId": "a7f3…",
"name": "Motor1 overspeed",
"state": "UNACK",
"priority": "critical",
"tagPath": "Line1/Filler/Motor1/Speed",
"value": 3120,
"limit": 3000,
"raisedAt": 1786454702113
}
}

Gotchas

  • Subscribe to raised only, unless you actually intend to send an all-clear. Adding cleared doubles the message volume, and a flapping alarm doubles it again.
  • Filter by priority here, not downstream. A pipeline that starts and then decides it had nothing to do has already paid for the execution.

See also