Route (Run) Started

The Run Started callback occurs when a route is started.


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