HyperTrackDocs
WebhooksGeotags, Geofences & Trips

Geotag

Webhook payload sent when a worker creates a geotag.

[
  {
  "created_at": "2019-07-01T14:01:00.000000Z",
  "recorded_at": "2019-07-01T14:00:00.000000Z",
  "data": {
    "order_handle": "order-1",
    "order_status": "arrived",
    "metadata": { "orderId": "123490809808" },
     "deviation": 14,
     "distance": 238,
     "duration": 63,
     "location": {
        "type": "Point",
        "coordinates": [ -6.2755, 57.6398983 ]
     },
    "expected_location": {
      "type": "Point",
      "coordinates": [ -6.2756, 57.6398983 ]
    },
    "worker_handle": "James"
  },
  "device_id": "00112233-4455-6677-8899-AABBCCDDEEFF",
  "type": "geotag",
  "version": "3.0.0"
  }
]
NameTypeDescription
data.order_handlestringUnique identifier for an order
data.order_statusstringLabel identifying a segment of order fulfillment
data.worker_handlestringUnique identifier for a worker
data.metadataObjectMetadata that you have assigned to this geotag (optional)
data.locationObjectLocation in GeoJSON format
data.expected_locationObjectLocation in GeoJSON format
data.location.typestringAs of right now, only Point is supported
data.location.coordinatesarrayArray of longitude latitude and (optional) altitude (in m)
data.expected_location.typestringAs of right now, only Point is supported
data.expected_location.coordinatesarrayArray of longitude latitude and (optional) altitude (in m)
data.deviationintDeviation between expected location and actual location
data.distanceintDistance travelled since last geotag
data.durationintTime since last geotag