Each time that a change/update is made from the Bringg side to the following fields, this webhook will be triggered. Bringg will send only the relevant fields changed (along with the identifying fields for the objects) UNLESS you request to receive the full Delivery Created payload:
- Address
- Note added
- Inventory quantity
- Scheduled time
- Delivery window
- Customer information (e.g. phone number, email address, name)
- Packages
If you wish to instead receive the full Delivery Created payload, you can configure this by checking the "Get full payload update for any Delivery Update" box below the Delivery Updated webhook endpoint:
The Delivery Updated webhook will have the same content as the Delivery Created webhook EXCEPT that is wrapped in another object (task) and your delivery ID as well as the task_id is on the top level:
{
"task_id": 26528270,
"delivery_id": "281745-your-delivery-id",
"task": {
"id": 26528270,
"title": "Order 002-758763",
"external_id": "002-758763-20210715",
...............
}
}
POST HTTP Method
The Delivery Updated webhook is sent using POST (and not PUT or PATCH).
What response Bringg expects from you
Only a success: true is required in the response. All other parameters are optional.
NOTE: delivery_cost is a float field that allows the fleet to send back their delivery cost to Bringg in Cents units.
{
"success": true,
"fleet_extras": {
"some": "important info"
},
"delivery_cost": 1050,
"green_delivery": true
}
EXAMPLE PAYLOADS FROM BRINGG
{
"task_id": 7694849,
"delivery_id": "123",
"way_point": {
"address": "6307 LAKE WHEELER RD",
"lat": 35.6959427,
"lng": -78.69186169999999,
"id": 11812926,
"position": 2
}
}
{
"task_id": 9896721,
"delivery_id": "ABCD1234",
"way_point": {
"address_second_line": "Apartment 3",
"id": 14840469,
"position": 2
}
}
{
"task_id": 7694849,
"delivery_id": "123",
"way_point": {
"scheduled_at": "2020-06-30T11:00:00.000Z",
"id": 11812925,
"position": 1
}
}
{
"task_id": 7694849,
"delivery_id": "123",
"way_point": {
"no_earlier_than": "2020-06-30T12:00:00.000Z",
"no_later_than": "2020-06-30T16:00:00.000Z",
"id": 11812925,
"position": 1
}
}
{
"task_id": 9896721,
"delivery_id": "ABCD1234",
"way_point": {
"phone": "+15555555556",
"id": 14840469,
"position": 2
}
}
{
"task_id": 9896721,
"delivery_id": "ABCD1234",
"way_point": {
"email": "[email protected]",
"id": 14840469,
"position": 2
}
}
{
"task_id": 9896721,
"delivery_id": "ABCD1234",
"task_inventory": {
"original_quantity": 3,
"id": 37792187,
"name": "Mild Chicken Sandwich"
}
}
{
"task_id": 7694849,
"delivery_id": "123",
"task_note": {
"id": 10284559,
"note": "Customer added a note",
"user_id": 660963,
"task_id": 7694849,
"created_at": "2020-06-09T12:59:29.883Z",
"updated_at": "2020-06-09T12:59:29.883Z",
"type": "TaskNote",
"way_point_id": 11812926,
"external_id": "10284559"
}
}
{
"task_id": 11277545,
"delivery_id": "ABCD1234",
"way_point": {
"scheduled_at": "2020-07-16T14:02:41.000Z",
"name": "Name Changed",
"id": 16672790,
"position": 2
}
}
{
"task_id": 11277918,
"delivery_id": "ABCD1234",
"way_point": {
"city": "Chicago",
"scheduled_at": "2020-07-16T14:37:27.000Z",
"id": 16673227,
"position": 2
}
}
{
"task_id": 9896721,
"delivery_id": "ABCD1234",
"way_point": {
"zipcode": "12345",
"id": 14840468,
"position": 1
}
}
{
"task_id": 11277918,
"delivery_id": "ABCD1234",
"way_point": {
"lat": 36,
"lng": -79,
"id": 16673227,
"position": 2
}
}
{
task_id: 123456789,
delivery_id: "ABCD1234",
task: {
id: 123456789,
packages: [
{
"id": 1,
"external_id": "testing_1",
"fleet_external_id": "fleet_id",
"label_url": "/label/url.zpl",
"name": "optional package name",
"description": "optional package description",
"notes": "optional package notes",
"sequence_number": null,
"merchant_id": 123,
"weight_value": 400,
"weight_unit": "g",
"volume_value": 5,
"volume_unit": "l",
"width_value": 100,
"width_unit": "mm",
"height_value": 54,
"height_unit": "mm",
"length_value": 45,
"length_unit": "mm",
"extras": { "a": 1 },
"created_at": "2021-12-23 17:38:44.734000",
"updated_at": "2021-12-23 17:38:44.734000",
"delete_at": null
},
{
"id": 2,
"external_id": "testing_2",
"fleet_external_id": "fleet_id_2",
"label_url": "/label/url2.zpl",
"name": "optional package name",
"description": "optional package description",
"notes": "optional package notes",
"sequence_number": null,
"merchant_id": 123,
"weight_value": 12892,
"weight_unit": "g",
"volume_value": 420,
"volume_unit": "l",
"width_value": 32,
"width_unit": "mm",
"height_value": 46,
"height_unit": "mm",
"length_value": 10,
"length_unit": "mm",
"extras": { "a": 2 },
"created_at": "2021-12-23 17:38:44.734000",
"updated_at": "2021-12-23 17:38:44.734000",
"delete_at": null
}],
preparation_status: "READY_FOR_PICKUP",
preparation_status_id: 3
}
}
BODY PARAMS
|
delivery_id string |
The delivery ID you provided for this order |
|
task_id Int32 |
Bringg's unique ID for this order |
|
way_point_id Int32 |
Bringg's ID for this way point. This allows you to identify which way point was updated. |
|
position Int32 |
The way point or stop number. Possible values are 1 for pickup and 2 for dropoff. |
|
no_earlier_than datetime |
The date and time of the beginning of the delivery time window. This is in UTC in the format "%Y-%m-%dT%H:%M:%S%z" |
|
no_later_than datetime |
The date and time of the end of the delivery time window. This is in UTC in the format "%Y-%m-%dT%H:%M:%S%z" |
|
scheduled_at datetime |
The date and time the order is scheduled for. This is in UTC in the format "%Y-%m-%dT%H:%M:%S%z" |
address string |
Address of the way point |
|
original_quantity Int32 |
The quantity of inventory items to be picked up or delivered |
|
delivery_cost float |
The fee that you are charging for delivery of this order, in Cents units. OPTIONAL |
|
green_delivery boolean |
Allows you to indicate whether a green vehicle will be delivering this order. OPTIONAL |
|
fleet_extras JSON |
Custom information that needs to be shared with Bringg. OPTIONAL |