API Reference

Driver Location Updated

The Driver Location Updated callback occurs when Bringg receives a location update for a driver.

📘

Register Your URL for this Webhook

To start receiving webhooks from Bringg, you must first register a URL. Detailed guidance on setting up and managing Bringg webhooks is available in the following resources:

Webhook

Below are the parameters included in the driver_location_updated webhook.

{
   "user_id": 13698624,
   "user_external_id": "13606790",
   "happened_at": 17146518449,
   "lat": 30.3657807,
   "lng": -97.7373743,
   "battery": 95,
   "accuracy": null,
   "started_tasks": [
      {
         "task_id": 374163410,
         "external_id": "177608872"
      }
   ],
   "webhook_type": "driver_location_updated",
   "merchant_id": 11111
}

Output Params

The driver_location_updated webhook includes the location_history object:

FieldDescriptionValidations and Notes
user_id
integer		The internal Bringg ID for the driver.
user_external_id
string		The external system's ID for the driver associated with this order.Maximum 255 characters
happened_at
integer		The time the driver location update was generated.This value is in Epoch time. Learn more about the formatting used in Bringg's parameters.
lat
integer		The latitude of the driver's location.
lng
integer		The longitude of the driver's location.
accuracy
double		Indicates the radius in meters around the reported latitude and longitude where the driver is likely to actually be located.
battery
integer		The remaining battery percentage of the driver's phone. Monitoring this data allows you to ensure that you retain constant contact with the driver while they are on shift.
started_tasks.task_id
integer		The ID of the active order in Bringg's system.
started_tasks.external_id
string		The ID of the active order in your external systems.Maximum 255 characters