Orders Geofence Checked · HyperTrack Docs

Webhook payload sent when the device checks if the worker is inside the order destination geofence.

Orders Geofence Checked Payload

[
   {
      "created_at":"2021-01-01T14:01:00.000000Z",
      "recorded_at":"2021-01-01T14:00:00.000000Z",
      "device_id":"00112233-4455-6677-8899-AABBCCDDEEFF",
      "worker_handle":"Worker-1",
      "account_id":"6784e919-7168-4f61-b686-2020f547637f",
      "type":"order",
      "data":{
         "is_inside":true,
         "metadata":{
            "storeId":"123490809808",
            "customerName":"Andrew"
         },
         "order_handle":"DGC127092",
         "route_handle":"4359cc65-90dd-4b2b-875b-26e6d2eba11d",
         "share_url":"https://trck.at/DqaybldkqY",
         "status":"ongoing",
         "value":"on_device_geofence_checked",
         "location_accuracy":20
      },
      "version":"3.0.0",
      "location":{
         "coordinates":[
            77.643271,
            12.94964
         ],
         "type":"Point"
      }
   }
]

Name	Type	Mandatory	Description
data.value	string	Yes	`on_device_geofence_checked`
data.order_handle	string	Yes	Unique handle for the Order
data.is_inside	boolean	Yes	Indication if the checkin was done inside or outside the order destination geofence; null if worker was in outage during check
data.outages	array	No	if worker was in an outage during the check, this is set with details about the outage
data.outages[].outage_category	enum	Yes	adversarial, behavioural, sporadic, os, reachability
data.outages[].outage_label	string	Yes
data.outages[].outage_code	string	Yes
data.outages[].outage_description	string	Yes
data.location_accuracy	integer	No	Accuracy of the location used to check whether it is inside order destination geofence or not
data.route_handle	string	No	Unique identifier of the route containing the order
data.status	string	Yes	Status of the order - `ongoing`\| `assigned`
data.share_url	string	No	Contains tracking url of the order to provide real time visibility of worker on route of this order
data.metadata	object	No	Metadata that you have assigned to this order