Notification Structure
Notification Code
Each notification is identified by the Notification Code that is unique for each notification type in EnergyAI.
For instance, the notification about a gateway going offline is identified by the notification code “OL001.1”.
Notification Attributes
Notification attributes are also included when a notification is dispatched by EnergyAI. These attributes contain information for the Apps to handle accordingly to personalize user journeys further and also identify the exact recipient (account and installation) of the notification. The below attributes may be present across notification types:
- end-user email [optional]
- gateway eui [optional]
- installation id (will be included in all notifications that are on installation level)
- timezone (optional)
- other notification type-specific attributes:
- e.g1., Power level alerts include an
alert_status
attribute field where its value (1,2,3,4) indicates which pre-configured threshold (1,2,3,4) was surpassed. - e.g2., Capacity Peak alerts include a
consumption_value
attribute field with the relevant value that indicates the exact consumption value that triggered the notification.
- e.g1., Power level alerts include an
Notification Codes & Attributes apply to all Notification Channels.
All installation-specific notifications can be personalized to match end-user preferences across their installations. See the Multiple installations guide for more information.
Updated about 2 months ago