Recipe 2 - Receiving Job Status updates (JSON via webhooks or Ftp)

Recipe 2 - Receiving Job Status updates (JSON via webhooks or Ftp)

Introduction

This recipe is for a Carrier who wants to receive Job status updates from a carrier using the Webhook interface.
The receiving Carrier will receive a JOBS webhook when a status is updated.
Each of the status webhooks must be setup on the server.

Receiving Job Status Updates - Webhooks

Status Updates

Status Status Meaning Relevance
28 Allocated - The load has been allocated to a Carrier or contractor Indicates that a Carrier has been dispatched the load
2 Assigned - The Load has been assigned to a driver Indicates that the Load is about to start
12 OnWayToCollect - The truck is onway to pickup the vehicles Estimated time of Pickup
13 AtCollection - The Truck has arrived at the pickup location On site and loading vehicles
16 OnWayToDeliver - The Truck is onway to deliver the vehicles Estimated time to delivery from the driver, Gate Out code from Pickup location
18 AtDelivery - The Truck has arrived at the delivery location On site and delivering vehicles

 

Status JSON Example

Status Field Definitions

Full Job Class Documentation

 

Stop Updates

Status Status Meaning Relevance
14 Collected - The Load has been collected Indicates that the Load has been loaded and signed off. Each vehicle then indicates if it has been collected, if there was any damage noted and who signed off the pickup.
24 Complete - The truck has completed the delivery Indicates that the Load has been delivered and signed off. Each vehicle then contains the pickup plus the delivery data including damage and signatures.

 

Stop JSON Example

Stop Field Definitions

Full Job Class Documentation

 

Suggested test tool webhook.site