Skip to content

Notification Template

Notification templates are used to configure all types of notifications that are sent to users by the system.

Notification Template Model

Field Type Description
id String The ID of the notification template.
name String The name of the notification template.
templateType String The type of the template. See all possible template types below.
group String The group of the notification. Can be state for the system notifications (state changes and events) and auth for account management.
content Object Text of the notification template.
content.single String Text of a single notification.
content.pack String Text of a group notification.
langCache Object The list of languages that the notification is sent for.
langCache.single Array<String> Languages for a single notification.
langCache.pack Array<String> Languages for a group notification.

Template types

  • email
  • email-subject
  • telegram
  • sms
  • registration
  • registration-subject
  • registration-password
  • registration-password-subject
  • forgot
  • forgot-subject

Template variables

A list of variables that can be used in the notification templates.

See the wiki article for more information and examples.

Basic variables

These variables can be used in any type of notifications:

Variable Description
entityName Element name.
entityId Element ID.
entityType Element type (object / link).
entityUrl Element URL.
stateName Name of the state.
stateData Information about the state.
changedStateText State transition text ("has passed to").
hasRootCause Indicates that transition is caused by a child element. Returns true, if the new state has been inherited from a child object, returns false, if the state has been changed because of other reason.
rootCauseEntityName Name of the child root-cause element.
rootCauseEntityUrl URL of the child root-cause element.
rootCauseEntityId ID of the child root-cause element.
condition Information about the triggered state change condition.
conditionDescription Description of the triggered condition.
eventTime The time when the event occurred.
breadcrumbs The path to the element which the notification comes about.

These variables also can be used within the variable breadcrumbs:

  • entityName
  • entityId
  • entityUrl

Parameters of the variable breadcrumbs (each parameter by default is equal to 0):

Variable Description
multi-break Whether to stop on a multi-parent (0 - no, 1 - yes).
depth The amount of displayed levels (0 - no limit).
length The largest number of symbols (0 - no limit).

Variables for group notifications

In addition to the basic variables there are some special ones which can be used in group notifications:

Variable Description
eventsCount Quantity of the events.
uniqueCount Quantity of the unique events.
fromTime Timestamp of the first event in the group.
toTime Timestamp of the least event in the group.

Additional variables for email-notifications

There are some additional variables for email-notifications:

Variable Description
stateLabel The coloured label of the state.
entityLink Name-URL to the element.
rootCauseEntityLink Name-URL to the child root-cause element.
goToObjectButton Button to open the element.