This contains all the information and data sent back to your server via a GET HTTP request on certain action changes.
When you specify a WebHook URL with any created booking by setting a URL in the "webhook" variable you will receive the following responses via GET on status changes:
| Variable | Description |
|---|---|
| status | This is the type of status message being sent. Seek Types below for a breakdown of different types. |
| message | This is a full text description of the type, this may contain ETA's, staff name, driver information, etc. This is variable and not standardized and should only be used to supplement a public front panel. |
| date | This is a UNIX timestamp of when this action took place. Webhooks may be up to 60 seconds delayed depending on network conditions. |
Statuses
Below are the different types of statuses you may receive and their descriptions.
| Status | Description |
|---|---|
| JOBSTARTED | This means that the driver has accepted this job and is now on the way. |
| QUEUED | This means that the job is now queued for an available driver. |
| APPROACHING | This means that the driver is now approaching the customers pickup location. This can also be considered the same as the "Waiting at Pickup" marker used by other systems. |
| PICKEDUP | This means that the driver has picked up the passenger, or as known in other systems, the "Passenger-On-Board" notice. |
| COMPLETED | This means that the journey has been completed successfully. |
| CANCELLED | This means that the ride has been cancelled by the fleet, the message will contain the reason for the cancellation. You should consider the booking cancelled within your system also. |
| DELAY | This is notice that there is a delay in picking up the customer. The message will contain the amount of time and a reason for the delay. |
| MODIFIED | This means the job has been modified by the fleet, the message will contain information about what has been modified, however we recommend calling the "check_live_bookings" API to get live data. |
| REFUSED | As you provided a WebHook during your API booking, the fleet will have the option to refuse the booking. This should be treated as a cancellation with the fleet only, if you hold a booking yourself, this should remain intact and refer it to either another fleet or continue to manage it yourself. |
| CONFIRMED | If the booking requires confirmation, this message will store on the fleets system that the remote fleet has confirmed and accepted this booking. |