Differences

This shows you the differences between two versions of the page.

--- ezeio2:userinterface:manage:destinations [2021-09-24 21:56] – ↷ Links adapted because of a move operation andreh
+++ ezeio2:userinterface:manage:destinations [2026-01-12 20:23] (current) – johpar
@@ Line 1: / Line 1: @@
 ====== Destinations & Destination Lists ======
 {{indexmenu_n>740}}
+The purpose of these two resources is to allow efficient management of message templates and where they are sent. Once created, a Destination List can be selected for an unlimited number of "Send message" alarm actions. If changes are required, such as on-boarding a new employee, simply edit the Destination List and the effect is account wide.
+Although visible from the groups under an account, Destinations and Destination List tabs are an account resource. If the users of a group need to create and manage their own Destinations and Destination Lists, their group must be upgraded to an account.
+<WRAP center round info 60%>
+To access Destinations and Destination List a user must be invited to an account and have the privilege "Can add/change destinations".
+</WRAP>
 === Destinations ===
-Destinations are the endpoints for messages sent via "Alarm Actions". These endpoints are typically various methods of connecting with human recipients, but API calls to other software programs is also an option. The "Destination" tab for each "Group" is like a address book, but since each destination is a single endpoint an individual human recipient may have multiple entries to list; email, cell phone, and text.
+Destinations are the endpoints for messages sent via "Alarm Actions". These endpoints are typically various methods of connecting with human recipients, but API calls to other software programs is also an option. The "Destination" tab for each "Account" is like a address book, but since each destination is a single endpoint an individual human recipient may have multiple entries to list; email, cell phone, and text.
 ^ Endpoint Type ^ Action ^ Example ^
@@ Line 12: / Line 21: @@
 | Call phone with voice message | Directs a voice message to the phone number entered | **US:** +12125551234 **AU:** +6130717523456 |
 | Send to Pushover | Directs a text message to an individual through the Pushover app, using their Pushover key | :abc123def456abc123def456abc123xy |
+| Send to Nagios | Nagios is a open source monitoring system. See https://www.nagios.org | https://my.nagiosserver.com/nrdp + access token |
+| Send command | Send a command to a different ezeio. See [[..:..:apiref:control|control API]] for possible commands. | Serial number of ezeio to send command to |
@@ Line 35: / Line 45: @@
 ----
-=== Headline ===
 === Message Templates ===
-The Message Template allows a user with adequate privileges, to customize the message assigned to each List Step (Destination) using plain text and [[ezeio2:userinterface:manage:meggagetemplates|Message Template tags]]. The Default message templates are tailored to the Destination Type, making the default SMS messages shorter than email. You can also choose to give more or different information to some Destinations (recipients). Message Template Tags  allow the message to contain current field values, device status, system info, meta data, even a Google maps link with the units location.
+The Message Template allows a user with adequate privileges, to customize the message assigned to each List Step (Destination) using plain text and [[ezeio2:userinterface:manage:messagetemplates|Message Template tags]]. The Default message templates are tailored to the Destination Type, making the default SMS messages shorter than email. You can also choose to give more or different information to some Destinations (recipients). Message Template Tags  allow the message to contain current field values, device status, system info, meta data, even a Google maps link with the units location.
 **__Default SMS Message Template__**
@@ Line 52: / Line 60: @@
 ^ Message structure ^ Message item ^ tags ^
-| Sender | ezeio S/N, Name  | Not customizable |
+| Sender | ezeio S/N, Name  | Default to ''{serial}@eze.io'', see below |
 | Subject | Message Type, Action Name | [SOURCENAME] [ACTIONAME] |
 | Body | Alarm Action Message, Date, Time  | [ACTIONMESSAGE] [ISODATE] [ISOTIME] |
-| Footer (Fixed) | https://ezeio & ezeio serial # | Not customizable |
+| Footer (Fixed) | https://ezeio & ezeio serial # | See below |
 |  |  |  |
-=== Customizing the subject ===
+=== Customizing the email subject ===
 Customize an email Message Template by adding your own Subject text or tags followed by the special character "|". Text and tags before the "|" will be formatted as the subject line, everything after the "|" will be formatted as the body of the email.
-**Example:** [SOURCENAME] [GROUPNAME] **|** [ACTIONMESSAGE] [USTIME] [GPSLINK]
+**Example:** ''[SOURCENAME] [GROUPNAME] **|** [ACTIONMESSAGE] [USTIME] [GPSLINK]''
+=== Customizing the email sender ===
+By default, the email sender will be ''{serial}@eze.io'', where ''{serial}'' is the serial number of the ezeio controller generating the email.
+In cases where the email is sent to some automated system that only accept specific senders, the email sender can be customized by using the Token field in the destination setting.
+If the token ends with an at (''@'') character, the text before the at-character will be used as the sender.
+Example : If the token is set to ''marvin@'', the sender address will be ''marvin@eze.io''. The domain cannot be customized.
+The token supports message tags, so ''[EZENAME]@'' will result in a sender address using the name of the ezeio. Please be aware that the resulting address must conform to valid email addresses (https://datatracker.ietf.org/doc/html/rfc2822)
+=== Customizing the email/SMS footer ===
+By default the system will automatically add a short footer with the serial number to email and SMS messages, and a preamble to voice messages. You can eliminate this by adding a caret (^) as the very last character in the message template.
+=== POST format ===
+When using the POST destination, the message will be formatted in JSON as follows (whitespace added for readability):
+<code javascript>
+{
+  "time": "2022-06-11T16:05:42Z",
+  "subject": "ALARM Alarm name",
+  "eventid": 90,
+  "type": "ALARM",
+  "source": "SEND",
+  "sourceid": 1,
+  "sourceindex": 1,
+  "sourcename": "Alarm name",
+  "actionname": "This is the action name",
+  "param1": "0.000000",
+  "param2": "0.000000",
+  "param3": "0.000000",
+  "param4": "0.000000",
+  "message": "The message body from the action",
+  "text": "",
+  "meta": {
+    "serial": "BAA-999",
+    "group": "55",
+    "accountgroupid": "2",
+    "name": "Name of controller",
+    "note": "Text from the note field",
+    "tzofs": "0"
+  },
+  "adc": {
+    "1": 2,
+    "2": 1,
+    "3": 2,
+    "4": 279,
+    "5": 5232,
+    "6": 2,
+    "7": 16960,
+    "8": 2,
+    "Vin": 12350,
+    "Vbat": 12268,
+    "V5": 5061
+  },
+  "out": {
+    "1": 0,
+    "2": 100,
+    "3": 0,
+    "4": 0
+  },
+  "pos": {
+    "x": 0,
+    "y": 0,
+    "z": 0,
+    "signal": 0
+  },
+  "fields": {
+    "1": {
+      "name": "Field 1",
+      "unit": "",
+      "assettag": [],
+      "raw": 9659017,
+      "value": "9,659,017"
+    },
+    "2": {
+      "name": "Field 2",
+      "unit": "",
+      "assettag": [],
+      "raw": 17,
+      "value": "17"
+    }
+  }
+}
+</code>
+Additionally, a "X-Hash" header is added to the message. The X-Hash is calculated as a SHA1 hash of the message payload text with the destination token appended at the end. This may be useful to validate the authenticity of the message.