WebHook API (Data Push)

A webhook sends data to your application when data is received at the server. You can configure the URL and query parameters used to route the request. Data is compiled as a JSON body and sent via HTTP POST.

General Output Format

 Gateway Message[(Sensor 1 Message)(Sensor 2 Message)(Sensor 3 Message)]
 

Gateway Parameters

Parameter Description
gatewayID A unique numertic identifier for the gateway.
gatewayName User designated gateway identifier.
networkID A unique numeric identifier for the network.
messageType Numerical value assigned to message.
power A numeric value indicating type of power.
batteryLevel A numeric value indicating battery power level.
date Time stamp of data message.
count The number of sensors.
signalStrength Strength of radio signal (0-100).
pendingChange Has pending configuration transaction to take place.

Sensor Parameters

Parameter Description
sensorID Sensor Identifier.
sensorName User designated sensor identifier.
applicationID Coded Sensor type (2 = Temperature, 4=Water, etc).
networkID A unique numeric identifier for the network.
dataMessageGUID A unique identifier for the message.
state Encoded state data (in general 0 = Normal, 2=Aware State).
messageDate Date message was delivered.
rawData Raw sensor data.
dataType Data discription (TemperatureData).
dataValue Parsed sensor data.
plotValues Parsed sensor data plot values
plotLabels Sensor data plot label. (Fahrenheit,Celsius etc..)
batteryLevel Approximate percentage remaining on battery.
signalStrength Strength of radio signal (0-100).
pendingChange Has pending configuration transaction to take place.
voltage A numeric value indicating voltage level.
Data String Example

Example (json)

 {
   "gatewayMessage":{
       "gatewayID":"10000" ,
       "gatewayName":"ExampleGateway" ,
       "accountID":"xxxx" ,
       "networkID":"xxxx" ,
       "messageType":"0" ,
       "power":"0",
       "batteryLevel": "101" ,
       "date": "6/18/2016 7:39:01 PM",
       "count":"3",
       "signalStrength": "29",
       "pendingChange": "False" 
   },
   "sensorMessages":[
      {
          "sensorID":"10001" ,
          "sensorName":"Temp1" ,
          "applicationID":"2" ,
          "networkID":"xxxx" ,
          "dataMessageGUID":"78642056-CBD8-43B0-9A4B-247E58D3B6CB",
          "state": "0" ,
          "messageDate": "6/18/2016 7:37:48 PM",
          "rawData":"23.7",
          "dataType": "TemperatureData",
          "dataValue": "23.7",
          "plotValues": "74.66",
          "plotLabels": "Fahrenheit",                           
          "batteryLevel": "100",
          "signalStrength": "100",
          "pendingChange": "False",
          "voltage": "3.24"
      }
    ]
 }