The Left Way Point callback occurs when the user (driver) notifies Bringg the user (driver) departed from a way point in an order. This callback returns detailed information describing the driver's departure from the way point.
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:
- Send Bringg Webhooks: Subscribe to webhooks and customize the fields in your callbacks.
- Webhook Authentication Methods: Ensure that your other systems recognize and accept webhooks from Bringg.
Response
{
"id": 33363526,
"scheduled_at": "2020-10-30T10:00:00.000Z",
"task_id": 24981076,
"customer_id": 12744836,
"eta": null,
"etl": "2020-10-08T07:20:42.018Z",
"name": "Warehouse",
"address": "5210 TRADEMARK DRIVE, RALEIGH, NC",
"address_second_line": null,
"done": true,
"address_type": null,
"location_name": null,
"no_earlier_than": null,
"no_later_than": null,
"lat": 35.7686299,
"lng": -78.5487832,
"phone": null,
"note": null,
"allow_editing_inventory": true,
"must_approve_inventory": false,
"zipcode": "27610",
"borough": null,
"city": "Raleigh",
"state": null,
"pickup_dropoff_option": 0,
"etos": 300,
"position": 1,
"webhook_type": "way_point_left",
"merchant_id": 275
}
{
"way_point": {
"id": 24250485,
"lat": 41.32918,
"lng": 2.04919,
"address": "Centro Comercial , Carrer de les Alberedes, 9",
"position": 1,
"scheduled_at": "2021-01-08T08:35:00.000Z",
"checkin_time": "2021-01-10T15:38:44.585Z",
"checkout_time": "2021-01-10T15:38:44.585Z",
"customer": {
"name": "Tienda Sant Boi [013]",
"address": "Centro Comercial Sant Boi, Carrer de les Alberedes, 9"
},
"task": {
"id": 20045176,
"title": "Pedido 013-943462",
"external_id": "013-943462-20210105",
"user": {
"id": 24008,
"name": "ADER/Andy Noriega Gil",
"external_id": "1973LFM",
"company": {
"name": "Ader"
}
},
"teams": [
{
"id": 3616,
"name": "Sant Boi [013]",
"external_id": "013"
}
]
}
},
"webhook_type": "way_point_left",
"merchant_id": 178
}
Output Params
The Left Destination webhook includes parameters from the Way Point Object.
Parameter | Description |
---|---|
allow_editing_inventory boolean | Indicates whether the driver is allowed to change inventory at this waypoint. Possible values:false or 0 - the driver is not allowed to change the inventorytrue or 1 - the driver is allowed to change the inventoryThe default value is true . |
allow_editing_original_quantity boolean | Indicates whether the driver is allowed to change the quantity of the inventory. Possible values:false or 0 - the driver is not allowed to change the quantity of the inventorytrue or 1 - the driver is allowed to change the quantity of the inventoryThe default value is false . |
allow_editing_payment boolean | Indicates whether the driver is allowed to change payment details and cost. Possible values:false or 0 - the driver is not allowed to change payment details and costtrue or 1 - the driver is allowed to change payment details and cost |
allow_scanning_inventory boolean | Indicates whether the driver is allowed to scan inventory as part of the handover process. Possible values:false or 0 - the driver is not allowed to scan the inventorytrue or 1 - the driver is allowed to scan the inventoryThe default value is false . |
allow_sending_email | Indicates whether emails are allowed to be sent to the customer on this waypoint. Possible values:false or 0 - do not send emailstrue or 1 - allow emails to be sentThe default value is true . |
automatically_checked_in int32 | The method used to check in to the waypoint. Possible values: 0 - Manually using the Driver App1 - Automatic check-in or check-out via geofence2 - Driver's action when prompted by the Driver App4 - Updated by linked task5 - Updated via API6 - Automated by activity trigger7 - Updated using the Bringg platform8 - Updated using the store app9 - Triggered by route end10 - Automatically updated by server11 - Updated via API13 - Triggered by completion of cluster pickup |
automatically_checked_out int32 | The method used to check out of the waypoint. Possible values: 0 - Manually using the Driver App1 - Automatic check-in or check-out via geofence2 - Driver's action when prompted by the Driver App4 - Updated by linked task5 - Updated via API6 - Automated by activity trigger7 - Updated using the Bringg platform8 - Updated using the store app9 - Triggered by route end10 - Automatically updated by server11 - Updated via API13 - Triggered by completion of cluster pickup |
base_etos int32 | The standard estimated time on site (ETOS) before inventory- and customer-based ETOS are calculated. This is measured in seconds. To calculate ETOS, Bringg takes the largest ETOS from the list as the initial value, and then adds a preconfigured value for each additional order. For example, for a group of orders including a bed and desk with installation times of 15 and 30 minutes, with a base value of 5 minutes, the combined ETOS is 35 minutes (30 + 5 ). |
automatically_geocoded boolean | Indicates if the address was automatically geocoded. Geocoding allows Bringg to ensure accurate display and navigation to waypoints. Possible values:false or 0 - was not automatically geocodedtrue or 1 - was automatically geocoded |
checkin_lat double | The driver's geographical latitude when checking in (arriving) at the waypoint. |
checkin_lng double | The driver's geographical longitude when checking in (arriving) at the waypoint. |
checkin_origin int32 | Indicates which system initiated check-in (arrival) at the waypoint. Possible values: 1 - Driver App2 - Bringg Platform3 - Background operations on the Bringg platform4 - Scheduled background operation on the Bringg platform5 - Customer experience app6 - Carrier via API7 - Floating inventory (for example, if the status of a floating inventory item changes)8 - Bringg automation |
checkin_time datetime | The date and hour of driver check-in (arrival) at the waypoint. |
checkout_lat double | The driver's geographical latitude when checking out (departing) from the waypoint. |
checkout_lng double | The driver's geographical longitude when checking out (departing) from the waypoint. |
checkout_origin int32 | Indicates which system initiated checkout (departure) from the waypoint. Possible values: 1 - Driver App2 - Bringg Platform3 - Background operations on the Bringg platform4 - Scheduled background operation on the Bringg platform5 - Customer experience app6 - Carrier via API7 - Floating inventory (for example, if the status of a floating inventory item changes)8 - Bringg automation |
checkout_time datetime | The date and hour of driver check-out (departure) from the waypoint. |
customer_contact_ids array of integers | An array of customer IDs associated with this waypoint. |
customer_id int32 | Bringg's ID for the customer. |
delete_at datetime | A null timestamp indicates that the entity is still active or present in Bringg. |
distance_traveled double | The actual distance traveled (in km). |
distance_traveled_client double | The distance traveled by the driver, calculated using the Driver App. |
distance_traveled_server double | The distance traveled by the driver, calculated by the Bringg server. |
driver_preparation_time int32 | The amount of time spent on site before delivering the order, such as the amount of time needed to go through security before reaching the customer. |
done boolean | Indicates whether this waypoint is done. |
find_me boolean 🚚 | Indicates whether the "find me" feature is active for this waypoint. When enabled, the "find me" feature allows customers to share their locations with the driver associated with their order. Possible values: 0 or false - the find me feature is not active for this waypoint1 or true - the find me feature is active for this waypoint. |
id int32 | Bringg's ID for the destination. |
late_reason string | The reason the driver is late. |
location_id int32 | Bringg's ID for the waypoint. |
masked_phone_number string | The associated phone number, if is is hidden in the Driver App. |
original_eta datetime | The post-optimization (promised) estimated time of arrival. |
original_etl datetime | The post-optimization estimated time of departure, based on original_eta and etos (estimated time on site). |
parking_spot object | For curbside pickup, this indicates the customer's parking spot. |
pending_geocode boolean | Indicates whether the geoposition latitude and longitude upload to Bringg are pending validation. Possible values:0 or false - The lat and lng are not pending validation.1 or true - the lat and lng are pending validation. |
predicted_etos int32 | When an estimated time on site (ETOS) is not available, Bringg predicts the ETOS based on existing data, such as similar orders and previous driver TOS. |
scheduled_at datetime | The date and time the order is scheduled to be fulfilled. |
silent boolean | Indicates if Bringg records the time when the driver arrived at the waypoint geofence but relies on manual input for check-in and check-out. Possible values:0 or false - silent mode is not active1 or true - silent mode is active. |
start_lat double | The geoposition latitude of the driver when this order started. |
start_lng double | The geoposition longitude of the driver when this order started. |
start_time datetime | The date and time when the order started. |
task object | The order associated with this waypoint. |
task_id int32 | Bringg's ID for the associated order. |
task_inventories object | An array of objects containing the inventory associated with this waypoint. See Order Inventories Object |
time_window_change_origin string | The system, process, or user action that initiated a change in the time window for this waypoint. Possible values: order_creation_api order_creation_csv order_creation_web customer_experience_web_user_rescheduled customer_experience_customer_rescheduled quotes_for_first_availability planned_delivery_window_without_quotes narrow_time_window order_update_api order_update_web automation_platform |
updated_at datetime | The date and time that this waypoint was last updated. |
workflow_id int32 | If a change was triggered by an automation, the automation ID is included here. |