HyperTrackDocs
WebhooksOrdersLifecycle

Orders Device Switched

Webhook payload sent when HyperTrack moves an order to a different device of the worker.

Order Device Switched Webhook 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":{
      "value":"device_switched",
      "order_handle":"DGC127092",
      "route_handle":"4359cc65-90dd-4b2b-875b-26e6d2eba11d",
      "status":"ongoing",
      "share_url":"https://trck.at/vr1RNLq",
      "previous_device_id":"00112233-4455-6677-8899-AABBCCDD8743",
      "new_device_id":"00112233-4455-6677-8899-AABBCCDDEEFF",
      "metadata":{
         "storeId":"123490809808",
         "customerName":"Andrew"
        }
     },
   "version":"3.0.0"
  }
]
NameTypeMandatoryDescription
data.valuestringYesdevice_switched
data.order_handlestringYesUnique handle for the Order
data.route_handlestringNoUnique identifier of the route containing the order
data.statusstringYesStatus of the order - ongoing| assigned
data.share_urlstringNoContains tracking url of the order to provide real time visibility of worker on route of this order
data.previous_device_idstringNoUnique Identifier of the device to which order was previously connected
data.new_device_idstringYesUnique Identifier of the device to which order is switched to
data.metadataobjectNoMetadata that you have assigned to this order