API Reference

Planning Done

This webhook is triggered when a set of orders organized into a route are marked as Done Planning.
This can be done manually by selecting orders in the Planning tab and choosing "Actions > Done Planning".

📘

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:


{
	runs: [
		{
      uuid: "e1022937-3861-4208-8ab0-483a59bb460b",
      external_id: "door 15",
      title: "North Eastern Route",
      orders: [{
	"id": 11880646,
	"title": "Rush Order",
	"created_at": "2018-03-13T15:30:09.000Z",
	"updated_at": "2018-03-13T15:35:03.000Z",
	"customer_id": 6458470,
	"user_id": 77484,
	"status": 4,
	"scheduled_at": "2018-03-13T23:00:00.000Z",
	"merchant_id": 11271,
  "additional_attributes": {
      "planned_distance_from_prev_task": 4.594
  },
	"way_points": [{
			"id": 14412587,
			"lat": 40.7076612,
			"lng": -74.0031032,
			"task_id": 11880646,
			"done": true,
			"created_at": "2018-03-13T15:30:08.864Z",
			"updated_at": "2018-03-13T15:34:35.427Z",
			"customer_id": 6463425,
			"address": "4196 Water St. , NY 10002",
			"position": 1,
			"scheduled_at": "2018-03-13T23:00:00.000Z",
			"checkin_time": "2018-03-13T15:34:09.000Z",
			"checkout_time": "2018-03-13T15:34:33.000Z",
			"note": null,
			"find_me": null,
			"asap": null,
			"late": false,
			"eta": null,
			"etl": "2018-03-13T23:05:00.000Z",
			"silent": false,
			"phone": null,
			"email": null,
			"delete_at": null,
			"checkin_lat": 32.0940472,
			"checkin_lng": 34.8283258,
			"checkout_lat": 32.0940134,
			"checkout_lng": 34.8283055,
			"etos": 300,
			"distance_traveled_client": null,
			"distance_traveled_server": 0,
			"automatically_checked_in": 0,
			"automatically_checked_out": 0,
			"merchant_id": 11271,
			"start_lat": 32.0940472,
			"start_lng": 34.8283258,
			"start_time": "2018-03-13T15:34:06.000Z",
			"estimated_distance": null,
			"estimated_time": null,
			"allow_editing_inventory": true,
			"must_approve_inventory": false,
			"address_second_line": null,
			"zipcode": null,
			"allow_scanning_inventory": null,
			"allow_editing_payment": null,
			"late_reason": null,
			"no_later_than": null,
			"no_earlier_than": null,
			"masked_phone_number": null,
			"twilio_number_id": null,
			"marked_late_at": null,
			"borough": null,
			"city": "New York",
			"distance_traveled": 0,
			"state": null,
			"delivery_confirmation_scan": null,
			"delivery_confirmation_note": null,
			"delivery_confirmation_photo": null,
			"delivery_confirmation_signature": null,
			"delivery_confirmation_form": null,
			"delivery_confirmation_ocr": null,
			"company_name": null,
			"customer_contact_ids": [6463425],
			"contacts": [],
			"allow_editing_original_quantity": null,
			"pickup_dropoff_option": null,
			"delivery_confirmation_cash": null,
			"district": null,
			"house_number": null,
			"street": null,
			"pending_geocode": false,
			"original_eta": null,
			"allow_automatic_set_coordinates": true,
			"has_to_leave_by": null,
			"extras": null,
			"customer": {
				"id": 6463425,
				"name": "Quick Stop Deli",
				"address": null,
				"lat": 32.0940472,
				"lng": 34.8283258,
				"created_at": "2018-03-13T15:30:08.836Z",
				"updated_at": "2018-03-13T15:34:11.286Z",
				"phone": null,
				"merchant_id": 11271,
				"image": null,
				"access_token": "9f2457c2-14f4-4ac1-97be-4a855542f1ec",
				"confirmation_code": "6791",
				"salt": null,
				"approved": false,
				"push_token": null,
				"uuid": "e1022937-3861-4208-8ab0-483a59bb460b",
				"email": null,
				"external_id": "6463425",
				"delete_at": null,
				"facebook_id": null,
				"extras": null,
				"original_lat_lng_changed": null,
				"encrypted_password": "",
				"blocked_email": false,
				"address_second_line": null,
				"zipcode": null,
				"allow_login": false,
				"stripe_id": null,
				"original_phone_number": "0123456789",
				"last_open_at": null,
				"last_order_at": null,
				"uploaded_profile_image": {
					"url": "/images/avatar.png"
				},
				"original_lat": null,
				"original_lng": null,
				"consecutive_checkins_out_of_geofence": 0,
				"allow_sending_email": false,
				"allow_sending_sms": true,
				"reset_password_token": null,
				"reset_password_sent_at": null,
				"mobile_version": null,
				"mobile_type": 0,
				"mobile_maker": null,
				"client_version": null,
				"client_name": null,
				"city": null,
				"borough": null,
				"state": null,
				"dev": false,
				"business_code": null,
				"language": null,
				"district": null,
				"house_number": null,
				"street": null,
				"allow_dynamically_updating_location": null,
				"is_sales_rep": false
			},
			"full_address": "4196 Water St. , NY 10002, New York"
		}, {
			"id": 14412588,
			"lat": 40.7119677,
			"lng": -73.9830995,
			"task_id": 11880646,
			"done": true,
			"created_at": "2018-03-13T15:30:08.908Z",
			"updated_at": "2018-03-13T15:35:02.934Z",
			"customer_id": 5140241,
			"address": "416 Water St. , NY",
			"position": 2,
			"scheduled_at": "2018-03-13T23:00:00.000Z",
			"checkin_time": "2018-03-13T15:34:36.000Z",
			"checkout_time": "2018-03-13T15:35:00.000Z",
			"note": null,
			"find_me": null,
			"asap": null,
			"late": false,
			"eta": null,
			"etl": "2018-03-13T23:05:00.000Z",
			"silent": false,
			"phone": "+9725456974815",
			"email": null,
			"delete_at": null,
			"checkin_lat": 32.0940134,
			"checkin_lng": 34.8283055,
			"checkout_lat": 32.0940592,
			"checkout_lng": 34.8283269,
			"etos": 300,
			"distance_traveled_client": null,
			"distance_traveled_server": 0.00421635199800195,
			"automatically_checked_in": 0,
			"automatically_checked_out": 0,
			"merchant_id": 11271,
			"start_lat": 32.0940472,
			"start_lng": 34.8283258,
			"start_time": "2018-03-13T15:34:35.654Z",
			"estimated_distance": null,
			"estimated_time": null,
			"allow_editing_inventory": true,
			"must_approve_inventory": false,
			"address_second_line": null,
			"zipcode": "10002",
			"allow_scanning_inventory": true,
			"allow_editing_payment": null,
			"late_reason": null,
			"no_later_than": null,
			"no_earlier_than": null,
			"masked_phone_number": null,
			"twilio_number_id": null,
			"marked_late_at": null,
			"borough": null,
			"city": "New York",
			"distance_traveled": 0.00421635199800195,
			"state": null,
			"delivery_confirmation_scan": null,
			"delivery_confirmation_note": null,
			"delivery_confirmation_photo": null,
			"delivery_confirmation_signature": 2,
			"delivery_confirmation_form": null,
			"delivery_confirmation_ocr": null,
			"company_name": null,
			"customer_contact_ids": [5140241],
			"contacts": [{
					"customer_id": 5140241,
					"contact_type": "phone",
					"contact_value": "+9725456974815",
					"sharing_allowed": true
				}
			],
			"allow_editing_original_quantity": null,
			"pickup_dropoff_option": 1,
			"delivery_confirmation_cash": null,
			"district": null,
			"house_number": null,
			"street": null,
			"pending_geocode": false,
			"original_eta": null,
			"allow_automatic_set_coordinates": true,
			"has_to_leave_by": null,
			"extras": null,
			"customer": {
				"id": 5140241,
				"name": "Fred's Sandwiche Barn",
				"address": "1900 Wall st, New York, NY",
				"lat": 32.0940134,
				"lng": 34.8283055,
				"created_at": "2018-01-08T09:32:58.164Z",
				"updated_at": "2018-03-13T15:34:37.846Z",
				"phone": "+9725456974815",
				"merchant_id": 11271,
				"image": "/images/avatar.png",
				"access_token": "8c870b26-dd4b-4324-8640-f45f23ef1c14",
				"confirmation_code": "8973",
				"salt": null,
				"approved": false,
				"push_token": null,
				"uuid": "ed43eb58-de0e-489e-a43b-30f37d63f40a",
				"email": null,
				"external_id": "5140241",
				"delete_at": null,
				"facebook_id": null,
				"extras": null,
				"original_lat_lng_changed": "2018-03-13T09:20:47.165Z",
				"encrypted_password": "",
				"blocked_email": false,
				"address_second_line": null,
				"zipcode": null,
				"allow_login": false,
				"stripe_id": null,
				"original_phone_number": "05456974815",
				"last_open_at": null,
				"last_order_at": null,
				"uploaded_profile_image": {
					"url": "/images/avatar.png"
				},
				"original_lat": 40.7060006,
				"original_lng": -74.008801,
				"consecutive_checkins_out_of_geofence": 0,
				"allow_sending_email": false,
				"allow_sending_sms": true,
				"reset_password_token": null,
				"reset_password_sent_at": null,
				"mobile_version": null,
				"mobile_type": 0,
				"mobile_maker": null,
				"client_version": null,
				"client_name": null,
				"city": null,
				"borough": null,
				"state": null,
				"dev": false,
				"business_code": null,
				"language": null,
				"district": null,
				"house_number": null,
				"street": null,
				"allow_dynamically_updating_location": null,
				"is_sales_rep": false
			},
			"full_address": "416 Water St. , NY, New York, 10002"
		}
	],
	"scans": null,
	"customer": {
		"id": 6458470,
		"name": "Fast Foods & Beverages",
		"address": "1900 Wall st, New York, NY",
		"lat": 32.0940772,
		"lng": 34.8284523,
		"created_at": "2018-03-13T09:19:57.562Z",
		"updated_at": "2018-03-13T15:30:08.810Z",
		"phone": "+972545454545",
		"merchant_id": 11271,
		"image": null,
		"access_token": "2ef3f376-3f46-436b-ad2b-45c83f830121",
		"confirmation_code": "2422",
		"salt": null,
		"approved": false,
		"push_token": null,
		"uuid": "fba3f307-eef0-4a67-883d-e46ddf02ac6a",
		"email": null,
		"external_id": "6458470",
		"delete_at": null,
		"facebook_id": null,
		"extras": null,
		"original_lat_lng_changed": "2018-03-13T14:38:51.145Z",
		"encrypted_password": "",
		"blocked_email": false,
		"address_second_line": null,
		"zipcode": null,
		"allow_login": false,
		"stripe_id": null,
		"original_phone_number": "0545454545",
		"last_open_at": null,
		"last_order_at": null,
		"uploaded_profile_image": {
			"url": "/images/avatar.png"
		},
		"original_lat": 40.706877,
		"original_lng": -74.0112654,
		"consecutive_checkins_out_of_geofence": 0,
		"allow_sending_email": false,
		"allow_sending_sms": true,
		"reset_password_token": null,
		"reset_password_sent_at": null,
		"mobile_version": null,
		"mobile_type": 0,
		"mobile_maker": null,
		"client_version": null,
		"client_name": null,
		"city": null,
		"borough": null,
		"state": null,
		"dev": false,
		"business_code": null,
		"language": null,
		"district": null,
		"house_number": null,
		"street": null,
		"allow_dynamically_updating_location": null,
		"is_sales_rep": false
	},
	"late": false,
	"external_id": "ABC250",
	"uuid": "75685ad3-be1d-4893-baa6-a911d15ffc16",
	"priority": 11880646,
	"dispatcher_id": null,
	"team_ids": [15132],
	"ready_to_execute": true,
	"started_time": "2018-03-13T15:34:06.000Z",
	"ended_time": "2018-03-13T15:35:00.000Z",
	"start_lat": 32.0940472,
	"start_lng": 34.8283258,
	"tip_driver_enabled": true,
	"tag_id": 8994,
	"automatically_assigned": false,
	"run_uuid": "60205a2d-8a2e-479a-8963-be3898677e03",
	"run_start_time": "2018-03-08T18:11:47.000Z",
	"last_assigned_time": "2018-03-13T15:30:16.000Z",
	"task_inventories": [{
			"id": 60269306,
			"task_id": 11880646,
			"quantity": 0,
			"original_quantity": 5,
			"merchant_id": 11271,
			"price": 500,
			"way_point_id": 14412588,
			"scan_string": "34242342342323432432234",
			"pending": null,
			"note": null,
			"parent_task_inventory_id": null,
			"coc_type": 0,
			"external_id": "12321312",
			"source_task_id": null,
			"inventory_id": 1238399,
			"name": "Best Bottled Water",
			"size": null,
			"image": "/images/product-placeholder.png",
			"inventory": {
				"id": 1238399,
				"name": "Best Bottled Water",
				"price": 500,
				"merchant_id": 11271,
				"external_id": "12321312",
				"scan_string": null,
				"commodity": null,
				"notes": null,
				"weight": null,
				"size": null,
				"extras": null,
				"delivery_cost": null,
				"completed": null,
				"width": null,
				"height": null,
				"length": null,
				"image": "/images/product-placeholder.png"
			}
		}
	],
	"task_notes": [{
			"id": 13023983,
			"note": {
				"Comment_Key": null,
				"Satisfaction_Key": 4,
				"Time_of_Day_Key": "n/a",
				"Unable_Key": false,
				"Type_Key": "\"Do not delivery if raining/snowing\""
			},
			"user_id": 77484,
			"task_id": 11880646,
			"created_at": "2018-03-13T15:35:01.837Z",
			"updated_at": "2018-03-13T15:35:01.837Z",
			"url": null,
			"way_point_id": 14412588,
			"customer_id": null,
			"pending_upload": false,
			"lat": 32.0940472,
			"lng": 34.8283258,
			"type": "Form"
		}, {
			"id": 13023963,
			"note": null,
			"user_id": 77484,
			"task_id": 11880646,
			"created_at": "2018-03-13T15:34:47.311Z",
			"updated_at": "2018-03-13T15:34:47.311Z",
			"url": {
				"url": "https://task-images-prod-us1.s3.amazonaws.com/uploads/signature/url/13023963/0c51c21c-09cf-4b93-a784-9182bde80af6.jpeg"
			},
			"way_point_id": 14412588,
			"customer_id": null,
			"pending_upload": false,
			"lat": 32.0940472,
			"lng": 34.8283258,
			"type": "Signature"
		}, {
			"id": 13023946,
			"note": {
				"Comment_Key": null,
				"Satisfaction_Key": 5,
				"Time_of_Day_Key": "n/a",
				"Unable_Key": false,
				"Type_Key": "\"Do not leave inside doorway\""
			},
			"user_id": 77484,
			"task_id": 11880646,
			"created_at": "2018-03-13T15:34:34.394Z",
			"updated_at": "2018-03-13T15:34:34.394Z",
			"url": null,
			"way_point_id": 14412587,
			"customer_id": null,
			"pending_upload": false,
			"lat": 32.0940472,
			"lng": 34.8283258,
			"type": "Form"
		}, {
			"id": 13023925,
			"note": null,
			"user_id": 77484,
			"task_id": 11880646,
			"created_at": "2018-03-13T15:34:22.192Z",
			"updated_at": "2018-03-13T15:34:22.192Z",
			"url": {
				"url": "https://task-images-prod-us1.s3.amazonaws.com/uploads/signature/url/13023925/acb752f8-212d-4d61-b7f0-b6fdf70cc256.jpeg"
			},
			"way_point_id": 14412587,
			"customer_id": null,
			"pending_upload": false,
			"lat": 32.0940472,
			"lng": 34.8283258,
			"type": "Signature"
		}, {
			"id": 13023601,
			"note": "Do not delivery through front entrance.",
			"user_id": 59172,
			"task_id": 11880646,
			"created_at": "2018-03-13T15:30:08.922Z",
			"updated_at": "2018-03-13T15:30:09.017Z",
			"url": null,
			"way_point_id": 14412588,
			"customer_id": null,
			"pending_upload": false,
			"lat": 32.1068165,
			"lng": 34.8348318,
			"type": "TaskNote"
		}
	],
	"fleet_id": null,
	"preparation_status": null,
	"task_type_id": 4,
	"user_external_id": "Your_Driver_Id_12345"
}], 
    }
	]
}
{
  "runs": [
    {
      "id": 79526257,
      "team_id": 51687,
      "scheduled_start_time": "2022-03-09T20:35:59.000Z",
      "tasks": [
        {
          "id": 222200132,
          "title": "Batch: i",
          "external_id": "6228aaa276c4850012f0b1a0",
          "priority": 2,
          "tag_id": 12876,
          "first_way_point_has_to_leave_by": null,
          "teams": [
            {
              "id": 51687,
              "external_id": "MAR1"
            }
          ],
          "way_points": [
            {
              "id": 302045542,
              "position": 1,
              "zipcode": "94607",
              "no_earlier_than": "2022-03-09T16:00:00.000Z"
            },
            {
              "id": 302045543,
              "position": 2,
              "zipcode": "94121",
              "no_earlier_than": "2022-03-09T21:00:00.000Z"
            }
          ]
        },
        {
          "id": 222200274,
          "title": "Batch: i",
          "external_id": "6228aada930cab001221cc84",
          "priority": 1,
          "tag_id": 12872,
          "first_way_point_has_to_leave_by": "2022-03-09T20:35:59.000Z",
          "teams": [
            {
              "id": 51687,
              "external_id": "MAR1"
            }
          ],
          "way_points": [
            {
              "id": 302045712,
              "position": 1,
              "zipcode": "94607",
              "no_earlier_than": "2022-03-09T16:00:00.000Z"
            },
            {
              "id": 302045713,
              "position": 2,
              "zipcode": "94121",
              "no_earlier_than": "2022-03-09T21:00:00.000Z"
            }
          ]
        }
      ],
      "planned_route": {
        "id": 2016,
        "title": "Route A",
        "external_id": "A"
      }
    }
  ],
  "webhook_type": "runs_planning_done",
  "merchant_id": 12549
}

Output params

runs

array of objects

Details of the route.

planned_route

array of objects

Details of the preset route identifier