How to configure your Datastream Http (Webhook) ?

Here is an article about how to configure your Datastream Webhook.

A Datastream Webhook is an HTTPS communication between our Wattsense backend and your web server.

Available only with a Tower subscription, when our backend will receive either a value, an event or an alarm from the Tower, it will be automatically sent to your web server.

Datastream Webhook architecture

Requirements to configure Datastream Webhook

In order to configure the Webhook communication correctly you'll have to get (from your web server parameters, Wattsense does not have them) the important informations that will allow our Backend to connect to it.

To do so, you will need :

Base URL	The base URL where your web server is accessible.
Event / Alarm / Values route	You'll have to fill the differents finals URLs routes where you want to receive the data.
Secret key	Key sent with the data to check the integrity of the message
Authentication	Here you'll see all the different authentication configurations. When you select one of them, you'll have to fill in the blanks according to your web server configuration.

 

Step by step configuration

Connector configuration

First of all, in the left menu "Organization" / Data Stream Tab, select the Organization where you want to create your Webhook datastream and click on "Add a connector".

You can create several Webhook connector per datastream

Name your Webhook Datastream and fill the blanks according to your web server requirements :

Triggers configuration

Once the communication setup is done, you will have to create the Triggers :

Triggers define what is required to call the connector and what values to send.

When you click on the " Create new trigger" button, here is the interface you'll have to fill:

• Select what type of trigger you want to receive in your Web server.
• Add the Tower(s) in the list in the scope of the trigger. (Note that you'll only see Towers in the current Organization, not from an other one.)

Activate the Datastream

At the end of the configuration, don't forget to activate the datastream by enabling the toggle button

 

Data format for Events

{
  "eventId":uuid,
  "deviceId":string,
  "code":int,
  "timestamp":Long,
  "commandStatusPayload":any
}

 

Here's an example with code 601 :

{   "eventId":"dd6f5636-0d0c-4691-8775-33a00f92e72e",   "deviceId":"193GFF0E",    "code":601,   "timestamp":1751293607776,   "commandStatusPayload":   {     "commandId":"68629ea761301165915ce042",     "operationStatus":"SENT",     "transmissionProtocol":"MQTT"   } }

 

Here's an example with code 2004 :

{   "eventId":"7ab9705b-3801-41d5-953-7256c68e6076",   "deviceId":"193GFF0E",   "code":2004,   "timestamp":1752135759712,   "message":"Network 'b3G1F2rSxkHgO': No Diematic master requests, maybe Master mode should be chosen" }

 

 

 

Data format for Alarms

{
  "name":string
  "deviceId":string,
  "alarmId":string,
  "status":"OPEN | ACKNOWLEDGED | CLOSED | DISABLED | ARCHIVED",
  "typeOfAlarm":"PROPERTY_MEASUREMENT | EQUIPMENT_STATUS",
  "lastTriggeredAt":Long,
  "triggeringValue":any,
  "priority":"STANDARD | CRITICAL",
  "externalId":string,
  "tags":map<string, string>,
  "triggeredBy":"SYSTEM | USER"
}

 

Here's an example of an alarm based on a property measurement :

{   "name":"Alarm to check datastream",   "deviceId":"193GFF0E",   "alarmId":"hIBCGMKGwmLfZbqs",   "status":"OPEN",   "typeOfAlarm":"PROPERTY_MEASUREMENT",   "lastTriggeredAt":1751293640506,   "triggeringValue":21,   "priority":"STANDARD",   "externalId":"plop",   "tags":null,   "triggeredBy":"SYSTEM" }

 

Here's an example of an alarm based on equipment status :

{   "name":"equipment offline",   "deviceId":"193GFF0E",   "alarmId":"3DFvjh2Ve0tQBJsr",   "status":"OPEN",   "typeOfAlarm":"EQUIPMENT_STATUS",   "lastTriggeredAt":1751900700278,   "triggeringValue":   [     {       "equipmentId":"mummxsG_hoojamla",       "dataPointExpected":4,       "dataPointGot":0     }   ],   "priority":"STANDARD",   "externalId":"plop",   "tags":null,   "triggeredBy":"USER" }

 

 

Data format for Values

The data is sent with the following structure :

deviceId: String,
property: String,
timestamp: Long,
payload: Any,
receivedAt: Long?
scaledPayload: Number?
name: String?
unit: String?
externalId: String?
propertyId: String?
equipmentId: String?
gatewayInterfaceId: String?
slug: String?
isOutOfService: Boolean?
tags: Map<String, String>

The ? at the end of the line means that the field can be null.

Here's an example :

 

{   "deviceId":"4gMO5pXOr",    "property":"wBrkDHgHIjEJwcqR",   "timestamp": 1705942271396,   "payload": 0,    "receivedAt": 1705942271819,   "scaledPayload": 0,   "name":"read 121",   "unit":"Am²",   "externalId":"plop",   "propertyId":"wBrkDHgHIjEJwcqR",   "equipmentId":"yeuBxbHQuhKEUyx",   "gatewayInterfaceId": null,   "slug":"yeubxbjqvuhkeuyx-read-121-jj37f2chkz",   "isOutOfService":null,   "tags":{} }

 

 

Troubleshooting Information

If the service malfunctions, a red sign will appear. Click on the small logo below:

to know more about the cause of the error :

 

If you need any additional information, please contact us here.