device_activity.md 1.54 KB

Device activity notification templatization


Notification subject and message fields support templatization. The list of available templatization parameters depends on the template type. See the available types and parameters below:

Available template parameters:

  • deviceId - the device id as uuid string;
  • deviceName - the device name;
  • deviceLabel - the device label;
  • deviceType - the device type;
  • eventType - one of: 'inactive', 'active';
  • recipientTitle - title of the recipient (first and last name if specified, email otherwise);
  • recipientEmail - email of the recipient;
  • recipientFirstName - first name of the recipient;
  • recipientLastName - last name of the recipient;

Parameter names must be wrapped using ${...}. For example: ${recipientFirstName}. You may also modify the value of the parameter with one of the suffixes:

  • upperCase, for example - ${recipientFirstName:upperCase}
  • lowerCase, for example - ${recipientFirstName:lowerCase}
  • capitalize, for example - ${recipientFirstName:capitalize}
Examples

Let's assume the notification about inactive thermometer device 'Sensor T1'. The following template:

Device '${deviceName}' inactive
{:copy-code}

will be transformed to:

Device 'Sensor T1' inactive


The following template:

${deviceType:capitalize} '${deviceName}' became ${eventType}
{:copy-code}

will be transformed to:

Thermometer 'Sensor T1' became inactive