API Reference

Destination Rescheduled (waypoint)

This callback is triggered when the scheduled time or time window on a way point is added or updated.

📘

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:


{
  "way_point": {
    "id": 17350981,
    "time_window_change_origin": "automation_platform",
    "workflow_id": 10381
    "scheduled_at": null,
    "task_id": 11796753,
    "customer_id": 9351450,
    "eta": null,
    "etl": null,
    "name": "Meira Puterman",
    "address": "409 SABRINA CIR",
    "address_second_line": null,
    "done": false,
    "address_type": null,
    "location_name": null,
    "no_earlier_than": "2020-08-09T13:00:00.000Z",
    "no_later_than": "2020-08-09T15:00:00.000Z",
    "lat": 41.2629659,
    "lng": -95.8156686,
    "phone": "+17737331475",
    "note": null,
    "allow_editing_inventory": true,
    "must_approve_inventory": false,
    "zipcode": "51503-4761",
    "borough": null,
    "city": "COUNCIL BLUFFS",
    "state": "IA",
    "pickup_dropoff_option": 1,
    "etos": 1500,
    "position": 2
  },
  "task_external_id": "1595320831",
  "webhook_type": "way_point_schedule_changed",
  "merchant_id": 49
}

Output Params

The Destination Rescheduled webhook includes parameters from the Way Point Object .

ParameterDescription
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 inventory
true or 1 - the driver is allowed to change the inventory
The 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 inventory
true or 1 - the driver is allowed to change the quantity of the inventory
The 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 cost
true 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 inventory
true or 1 - the driver is allowed to scan the inventory
The 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 emails
true or 1 - allow emails to be sent
The default value is true.
automatically_checked_in
int32
The method used to check in to the waypoint.
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- Updated by linked task
5- Updated via API
6- Automated by activity trigger
7- Updated using the Bringg platform
8- Updated using the store app
9- Triggered by route end
10- Automatically updated by server
11- Updated via API
13 - 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 App
1- Automatic check-in or check-out via geofence
2- Driver's action when prompted by the Driver App
4- Updated by linked task
5- Updated via API
6- Automated by activity trigger
7- Updated using the Bringg platform
8- Updated using the store app
9- Triggered by route end
10- Automatically updated by server
11- Updated via API
13 - 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 geocoded
true 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 App
2 - Bringg Platform
3- Background operations on the Bringg platform
4 - Scheduled background operation on the Bringg platform
5 - Customer experience app
6 - Carrier via API
7 - 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 App
2 - Bringg Platform
3- Background operations on the Bringg platform
4 - Scheduled background operation on the Bringg platform
5 - Customer experience app
6 - Carrier via API
7 - 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 waypoint
1 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_etaand 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 latand 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 active
1 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.