HyperTrackDocs
WebhooksDevices

Battery

Webhook payload sent when the battery status of a device changes.

2.0.0 Payload

[
  {
   "created_at":"2019-07-01T20:00:01.247377Z",
   "device_id":"00112233-4455-6677-8899-AABBCCDDEEFF",
   "recorded_at":"2019-07-01T20:00:00.000000Z",
   "type":"battery",
   "data":{
      "value":"low"
     },
   "location":{
      "type":"Point",
      "coordinates":[
         -6.2755,
         57.6398983124
      ]
     },
   "version":"2.0.0"
  }
]
NameTypeDescription
data.valuestringBattery status. Values include low, normal and charging
locationobjectLocation in GeoJSON format
location.typestringAs of right now, only Point is supported
location.coordinatesarrayArray of longitude latitude and (optional) altitude (in m)

2.1.0 Payload

[
  {
   "created_at":"2021-12-21T20:36:37.752Z",
   "device_id":"00112233-4455-6677-8899-AABBCCDDEEFF",
   "recorded_at":"2021-12-21T20:36:34.410Z",
   "type":"battery",
   "data":{
      "value":"low",
      "battery_percent":75
     },
   "version":"2.1.0"
  }
]
NameTypeDescription
data.valuestringBattery status. Values include low, normal and charging
data.battery_percentintBattery percentage

2.1.0 battery payloads require a minimal a SDK version of 4.9.0 for iOS and 5.4.1 for Android.