HyperTrackDocs
WebhooksOrdersLifecycle

Order Assigned

Webhook payload sent when an order is assigned to a worker.

Order Assigned 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":"assigned",
      "order_handle":"DGC127092",
      "assigned_at": "2021-01-01T14:00:00.000Z",
      "route_handle":"4359cc65-90dd-4b2b-875b-26e6d2eba11d",
      "assign_source": "automated",
      "status":"assigned",
      "metadata":{
         "storeId":"123490809808",
         "customerName":"Andrew"
        }
     },
   "version":"3.0.0"
  }
]
NameTypeMandatoryDescription
data.valuestringYesassigned
data.order_handlestringYesUnique handle for the Order
data.route_handlestringYesUnique identifier of the route containing the order
data.assigned_attimestampYesTimestamp indicating when the order was assigned
data.statusstringYesStatus of the order - assigned
data.assign_sourceenumNoEnumerated string to distinguish how did the order get assigned, either manual or automated
data.metadataobjectNoMetadata that you have assigned to this order