Planon IoT : IoT Platform - Developer's Guide : Rules Endpoints : Rules/Post : Request – Rules/Post – emailProperties
Request – Rules/Post – emailProperties
Property
Type
Description
Mandatory
actions/emailProperties
Array
These are the actions properties to be filled out in order to trigger the sending of an email –
“emailProperties”: {
“message”: “{severity} alarm from {deviceName} – {triggeringEvent} {operator} {threshold} on value {value}”,
“subject”: “{name} triggered”,
“userIds”: [],
“userDetails”: [
{
“name”: “-“,
“phoneNumber”: null,
“email”: “user@axonize.com”
}
]
},
“smsProperties”: null,
“phoneCallProperties”: null,
“alarmInstanceProperties”: null,
“eventLogEntryProperties”: null,
“commandProperties”: null,
“webServiceProperties”: null,
“ruleRecurrenceSettings”: null
actions/emailProperties/message
Object
The message of the email to be sent. Various IoT Platform keywords can be included in the message inside brackets {}. For example –
“message”: “{severity} alarm from {deviceName} – {triggeringEvent} {operator} {threshold} on value {value}”,
These keywords enable you to include information retrieved by IoT Platform in the message. For more details about keywords, see  IoT Platform Message Keywords.
Default messages and keywords are provided for each country and they can be localized (translated).
actions/emailProperties/subject
String
The subject of the email to be sent.  IoT Platform keywords can also be included in the subject, as described above.
actions/emailProperties/userIds
String
One or both these fields can be used to define the users to whom to send the email –
• userIds is a list of the IoT Platform User IDs. The email of each user is defined in Users.
“userIds” : [
“58346e394e123c088069d384”,
“583589234e123c088069d48e”,
“59cb7d26e5742d1711231cd1”,
“51234e240922dcf172c467778”
]
• userDetails enables you to define the recipients to whom to send email in the structure below –
“userDetails”: [
{“name”: “-“,
“phoneNumber”: null,
“email”: “user@axonize.com”
}
actions/emailProperties/userDetails
String