HyperTrackDocs
WebhooksRoutes

Route Started

Webhook payload sent when a route starts.

Route Started 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":"started",
      "route_handle":"4359cc65-90dd-4b2b-875b-26e6d2eba11d",
      "status":"tracking",
      "embed_url":"https://embed.hypertrack.com/trips/4359cc65-90dd-4b2b-875b-26e6d2eba11d?publishable_key=lujVNBunxFFHBQ2gk980UqQ3KQemmKRsqlATo4nes959pKEo9nAqxv60Sk1r1HR_KSpdZ0feR4FLajKuw",
      "metadata":{
        "storeId":"123490809808",
        "customerName":"Andrew"
      }
     },
   "version":"3.0.0"
  }
]
NameTypeMandatoryDescription
data.valuestringYesstarted
data.route_handlestringYesUnique identifier of the route
data.statusstringYesStatus of the route - tracking
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 fulfil the batch of orders