Arrived to Destination (Check-in)

📘
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": 22465011,
   "scheduled_at": "2020-11-25T15:00:00.000Z",
   "task_id": 18623172,
   "customer_id": 16100117,
   "eta": "2020-11-25T13:53:04.000Z",
   "etl": "2020-11-25T13:57:08.000Z",
   "name": "Customer Name",
   "address": "155 YORK WAY",
   "address_second_line": "",
   "done": false,
   "address_type": null,
   "location_name": null,
   "no_earlier_than": "2020-11-25T14:00:00.000Z",
   "no_later_than": "2020-11-25T15:00:00.000Z",
   "lat": 51.5481276,
   "lng": -0.1280183,
   "phone": null,
   "note": null,
   "allow_editing_inventory": true,
   "must_approve_inventory": true,
   "zipcode": "N7 9LN",
   "borough": "",
   "city": "LONDON",
   "state": "",
   "pickup_dropoff_option": 1,
   "etos": 300,
   "position": 2,
   "webhook_type": "way_point_arrived",
   "merchant_id": 46
}

Output Params

The Arrived to 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 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` _boolean	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_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 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.