Template parameters
Each notification template has a type that determines which parameters are available. The type must match the trigger you plan to use it with — for example, an Alarm template can only be used in an alarm notification rule. For an overview of templates and rules, see Notification center.
General
Section titled “General”When to use: Any notification that isn’t tied to a specific system event — maintenance announcements, custom broadcasts, or one-off messages sent manually or via the REST API.
Example:
Subject: Scheduled maintenance tonight, ${recipientFirstName:capitalize}Message: Hi ${recipientFirstName:capitalize}, the platform will be offline for maintenance on March 5 from 2:00–4:00 AM UTC.| Parameter | Description |
|---|---|
recipientTitle | Full name of the recipient, or email address if the name is not set. |
recipientEmail | Email address of the recipient. |
recipientFirstName | First name of the recipient. |
recipientLastName | Last name of the recipient. |
When to use: Alert engineers or operators when a HMI Device or asset alarm is created, changes severity, is acknowledged, cleared, or deleted. Pair with the Alarm notification rule and an escalation chain for on-call routing.
Example:
Subject: New ${alarmSeverity:upperCase} alarm: ${alarmType}Message: ${alarmOriginatorEntityType} "${alarmOriginatorName}" triggered a ${alarmSeverity} alarm. Status: ${alarmStatus}.Renders as: New CRITICAL alarm: High Temperature / Device “Compressor BJ-66” triggered a critical alarm. Status: ACTIVE.
Includes all General parameters, plus:
| Parameter | Description |
|---|---|
alarmType | Alarm type. |
action | One of: created, severity changed, acknowledged, cleared, deleted. |
alarmId | Alarm ID (UUID). |
alarmSeverity | Alarm severity (lowercase). |
alarmStatus | Alarm status. |
alarmOriginatorEntityType | Entity type of the alarm originator, like Device. |
alarmOriginatorName | Name of the alarm originator, like Sensor T1. |
alarmOriginatorId | Alarm originator entity ID (UUID). |
alarmOriginatorLabel | Label field of the alarm’s originating entity. |
Device activity
Section titled “Device activity”When to use: Notify operators when a goes offline unexpectedly or comes back online. Useful for monitoring field devices with intermittent connectivity.
Example:
Subject: Device "${deviceName}" is now ${eventType}Message: Device "${deviceName}" (type: ${deviceType}) changed status to ${eventType}.Renders as: Device “Compressor BJ-66” is now inactive / Device “Compressor BJ-66” (type: HVAC) changed status to inactive.
Includes all General parameters, plus:
| Parameter | Description |
|---|---|
deviceId | Device ID (UUID). |
deviceName | Device name. |
deviceLabel | Device label. |
deviceType | Device type. |
eventType | One of: inactive, active. |
Entity action
Section titled “Entity action”When to use: Audit trail notifications when entities (devices, assets, customers, users) are created, modified, or deleted. Useful for change control in large teams.
Example:
Subject: ${entityType:capitalize} ${actionType} by ${userEmail}Message: ${entityType} "${entityName}" was ${actionType} by ${userFirstName:capitalize} ${userLastName:capitalize} (${userEmail}).Renders as: Device added by admin@company.io / Device “Sensor NM-12” was added by John Doe (admin@company.io).
Includes all General parameters, plus:
| Parameter | Description |
|---|---|
entityType | Entity type, like Device. |
entityId | Entity ID (UUID). |
entityName | Entity name. |
actionType | One of: added, updated, deleted. |
userId | ID of the user who performed the action. |
userEmail | Email of the user who performed the action. |
userFirstName | First name of the user. |
userLastName | Last name of the user. |
Alarm comment
Section titled “Alarm comment”When to use: Keep the alarm owner or team in the loop when a colleague comments on an active alarm. Avoids the need to manually check the alarm timeline.
Example:
Subject: New comment on "${alarmType}" alarmMessage: ${userFirstName:capitalize} ${userLastName:capitalize} ${action} a comment on the ${alarmSeverity} alarm for "${alarmOriginatorName}": "${comment}"Renders as: New comment on “High Temperature” alarm / Jane Smith added a comment on the critical alarm for “Compressor RK-25”: “Checked on-site — coolant level is low.”
Includes all Alarm parameters, plus:
| Parameter | Description |
|---|---|
comment | Text of the comment. |
action | One of: added, updated. |
userEmail | Email of the user who left the comment. |
userFirstName | First name of the user. |
userLastName | Last name of the user. |
userTitle | A pre-formatted display name: userFirstName + " " + userLastName, falling back to email if both name fields are empty. |
Alarm assignment
Section titled “Alarm assignment”When to use: Notify the assigned engineer when an alarm is routed to them, or notify the team when an alarm is unassigned.
Example:
Subject: Alarm "${alarmType}" assigned to youMessage: ${userEmail} assigned a ${alarmSeverity} alarm on "${alarmOriginatorName}" to ${assigneeEmail}.Renders as: Alarm “High Temperature” assigned to you / supervisor@company.io assigned a critical alarm on “Compressor BJ-66” to engineer@company.io.
Includes all Alarm parameters, plus:
| Parameter | Description |
|---|---|
assigneeEmail | Email address of the assignee. |
assigneeFirstName | First name of the assignee. |
assigneeLastName | Last name of the assignee. |
assigneeTitle | A pre-formatted display name: assigneeFirstName + " " + assigneeLastName, falling back to email if both name fields are empty. |
assigneeId | Assignee ID (UUID). |
userEmail | Email of the user who performed the action. |
userFirstName | First name of the user. |
userLastName | Last name of the user. |
userTitle | A pre-formatted display name: userFirstName + " " + userLastName, falling back to email if both name fields are empty. |
action | One of: assigned, unassigned. |
Using parameters
Section titled “Using parameters”Wrap any parameter name in ${...} — for example, ${recipientFirstName}. Apply a suffix after a colon to transform the value:
| Suffix | Example | Result | When to use |
|---|---|---|---|
upperCase | ${recipientFirstName:upperCase} | JOHN | Email subject lines, headers, emphasis |
lowerCase | ${recipientFirstName:lowerCase} | john | URLs, technical identifiers |
capitalize | ${recipientFirstName:capitalize} | John | Proper grammar in message bodies |
Tip: Combine parameters with plain text to compose natural sentences. For example:
Subject: New ${alarmSeverity:upperCase} alarm on ${alarmOriginatorName}Message: Hi ${recipientFirstName:capitalize}, a ${alarmSeverity} alarm of type "${alarmType}" was ${action} on device "${alarmOriginatorName}".Renders as: New CRITICAL alarm on Compressor BJ-66 / Hi Jane, a critical alarm of type “High Temperature” was created on HMI Device “Compressor BJ-66”.