API Reference

Route (Run) Started

The Run Started callback occurs when a route is started.

📘

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 Run Started webhook is sent to your designated URL when a route starts, and by default includes route, task, waypoint, and user details. The start of a route can be triggered manually in the driver app, automatically when the assigned driver leaves your team location, or, for on-demand orders, when ending a prior run with open orders.

Webhook

Below are the default parameters included in the Run Started webhook. 

{
  "run": {
    "id": 343433934,
    "user_id": 39483,
    "team_id": 394839432,
    "scheduled_end_time": "2024-02-05T19:00:00.000Z",
    "external_id": "343433934",
    "start_lat":40.758896,
    "start_lng":-73.985130,
    "start_method": 1,
    "started_at":"2024-02-05T11:00:30.336Z",
    "tasks": [
      {
        "external_id": "4545421",
        "title":"Order for James 4545421",
        "id": 4545484542,
        "status": 6,
        "way_points": [
          {
            "external_id": "5454115",
            "position": 1,
            "scheduled_at": "2024-02-05T11:23:19.017Z",
            "eta": "2024-02-05T11:30:00.017Z",
            "address": "1 Main St. Smalltown New York 11111"
          }
        ]
      }
    ],
    "user": {
      "id": 343343,
      "name":"Zachary Smith",
      "status": "online",
      "sub": "Assigned",
      "phone": "+1234123445698",
      "external_id": "34834839"
    }
  },
  "webhook_type": "run_started",
  "merchant_id": 1,
}

Output Params

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.