HyperTrackDocs
WebhooksRoutes

Route Candidate Device Updated

Webhook payload sent when the list of candidate devices for a route changes.

Route Candidate Devices Updated 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": "route",
    "data": {
      "value":"candidate_devices_updated",
      "route_handle":"4359cc65-90dd-4b2b-875b-26e6d2eba11d",
      "embed_url":"https://embed.hypertrack.com/trips/4359cc65-90dd-4b2b-875b-26e6d2eba11d?publishable_key=lujVNBunxFFHBQ2gk980UqQ3KQemmKRsqlATo4nes959pKEo9nAqxv60Sk1r1HR_KSpdZ0feR4FLajKuw",
      "status":"tracking",
      "fulfillment_date":"2021-01-01",
      "metadata":{
         "storeId":"123490809808",
         "customerName":"Andrew"
        },
      "candidate_devices": [
        "00112233-4455-6677-8899-AABBCCDDEEFF",
        "33221100-4455-6677-8899-AABBCCDDEEFF"
      ]
    },
    "version": "3.0.0"
}
NameTypeMandatoryDescription
data.valuestringYescandidate_devices_updated
data.route_handlestringYesUnique identifier of the route
data.statusstringYesStatus of the route - planned, assigned, or tracking
data.fulfillment_datestringNoFulfillment date of the plan that contains the route, in YYYY-MM-DD format. Present only when the route has a plan with a fulfillment date
data.metadataobjectNoMetadata that you have assigned to this route
data.embed_urlstringYesEmbeddable url of the route to provide real time visibility of worker on route to fulfill the batch of orders
data.candidate_devicesarrayYesList of candidate devices available for this route.
Updated list after addition/removal of a candidate device.