API Reference

Route Plan Updated

The Route Plan Updated callback occurs when a route is updated by optimization or by manual changes.

📘

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:

The Route Plan Updated webhook includes the Run Object.

Triggers include changes in Bringg's Route Planner, such as:

  • New route created
  • Driver, vehicle, or trailer updated
  • Planned route ID updated
  • Order assigned to or unassigned from a route
  • Order priority updated

Below are the default parameters included in the Route Plan Updated webhook.

{
  "run": {
    "id": 123456789,
    "user_id": 98765,
    "external_id": "456456",
    "team_id": 325545,
    "vehicle_id": 54512,
    "scheduled_start_time": "2023-10-24T11:00:00.000Z",
    "scheduled_end_time": "2023-10-24T21:23:05.000Z",
    "tasks": [
      {
        "id": 987654321,
        "title": null,
        "status": 1,
        "external_id": "5454544",
        "way_points": [
          {
            "id": 430151283,
            "address": "1 Main Street Chicago IL [...]",
            "position": 2,
            "scheduled_at": "2023-10-24T19:42:22.000Z",
            "eta": "2023-10-24T19:42:22.000Z"
          }
        ]
      },
      {
        "id": 879456123,
        "title": null,
        "status": 1,
        "external_id": "54545454",
        "way_points": [
          {
            "id": 454564,
            "address": "242 Second Street Chicago IL [...]",
            "position": 2,
            "scheduled_at": "2023-10-24T19:36:25.000Z",
            "eta": "2023-10-24T19:36:25.000Z"
          }
        ]
      },
      // ... (other tasks)
    ]
  }
}

ParameterDescription
end_lat
double
The latitude of the route when it was ended.
end_lng
double
The longitude of the route when it was ended.
end_method
int32
Indicates the method used to end this route.
Possible values:
0 - manually using the Driver App
1 - automatic check-in or check-out via geofence
2 - driver's action when prompted by the Driver App
4 - auto-corrected by client
5 - auto-corrected by server
6 - automated by activity trigger
7 - updated in the Bringg platform
8 - updated in the store app
9 - from run end
10 - updated by Bringg automation
ended_at
datetime
The date and time when this route was ended, formatted as "%Y-%m-%dT%H:%M:%S%z" and according to the UTC time zone.
external_id
Int32
Your external system's ID for this run. Appears as planned_route_external_id when included outside of the run object.
id
Int32
The ID Bringg assigns to a run when it is created.
Use only in theupdate_task API request. When using update_task, either id or external_id can be indicated in the run object.
planned_route_id
Int32
Bringg's ID for the planned route. Planned routes are created in advanced (not created using AutoDispatch).
run_configuration_id
Int32
Refers to the GPS configuration (x seconds between location updates) per user status. Values include: Free =>10, "Started" =>10, "Assigned" =>10, "Checked-In" =>10, "Late" =>10}
scheduled_end_time
datetime
The date and time when this route is scheduled to end, formatted as "%Y-%m-%dT%H:%M:%S%z" and according to the UTC time zone.
scheduled_start_time
datetime
The date and time when this route is scheduled to begin, formatted as "%Y-%m-%dT%H:%M:%S%z" and according to the UTC time zone.
start_lat
double
The latitude of the route when it was started.
start_lng
double
The longitude of the route when it was started.
start_method
int32
Indicates the method used to start this route.
Possible values:
0 - manually using the Driver App
1 - automatic check-in or check-out via geofence
2 - driver's action when prompted by the Driver App
4 - auto-corrected by client
5 - auto-corrected by server
6 - automated by activity trigger
7 - updated in the Bringg platform
8 - updated in the store app
9 - from run end
10 - updated by Bringg automation
started_at
datetime
The date and time when this route was started, formatted as "%Y-%m-%dT%H:%M:%S%z" and according to the UTC time zone.
tasks
array
An array of order (task) objects. Read more about the Order (Task) Object
team_id
Int32
Bringg's ID for the team assigned to this route.
Can be indicated in the task object or run object. If indicated in task object, team_id must be omitted or match in run object.
user
object
An object including the details of the driver assigned to this route.
user_external_id
Int32
Your external system's ID for the driver assigned to this route.
user_id
Int32
Bringg's ID for the driver assigned to this route.
Can be indicated in the task object or run object. If indicated in task object, user_id must be omitted or matched in the run object.
vehicle_id
Int32
Bringg's ID for the vehicle assigned to a route.