API Reference

Orders Ready to be Executed

This webhook is triggered when when orders in Planning are marked as "ready to execute". This can happen when a dispatcher in the Planning tab clicks the button to send orders to drivers; or through a scheduled job calls the Release action.

📘

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:


Response

{
   "user": {
      "id": 31317,
      "name": "John Smith",
      "email": "",
      "status": "online",
      "sub": "Started",
      "phone": "+",
      "job_description": null,
      "external_id": "31317"
   },
   "tasks": [
      {
         "id": 123456789,
         "title": "PEDIDO ZF",
         "customer_id": 18847296,
         "user_id": 31317,
         "created_at": "2021-01-11T15:15:32.000Z",
         "updated_at": "2021-01-12T09:41:10.000Z",
         "status": 6,
         "merchant_id": 178,
         "external_id": "013-940071",
         "uuid": "810219f2-99a7-4538-9494-902f3cecc45a",
         "priority": 20174494,
         "total_price": null,
         "origin_id": 1389,
         "tag_id": 537,
         "task_type_id": null,
         "fleet_id": null,
         "teams": [
            {
               "name": "Sant Boi [013]"
            }
         ],
         "way_points": [
            {
               "id": 24426916,
               "lat": 41.3783128,
               "lng": 2.1539369,
               "done": false,
               "customer_id": 18847296,
               "address": "Gran Via de les Corts Catalanes, 442, Barcelona, Spain",
               "position": 1,
               "scheduled_at": "2021-01-12T07:00:00.000Z",
               "checkin_time": null,
               "checkout_time": null,
               "eta": null,
               "etl": "2021-01-12T07:15:00.000Z",
               "phone": "+",
               "email": "",
               "no_later_than": null,
               "no_earlier_than": null,
               "task": {
                  "preparation_external_id": null,
                  "payment_type_name": null,
                  "dispatcher_id": null,
                  "preparation_end_time_actual": null,
                  "delivery_cost": null,
                  "priority": 20174494,
                  "tag_id": 537,
                  "shift_id": 2091349,
                  "fleet_id": null,
                  "payment_method": null,
                  "cancelled_at": null,
                  "cancellation_lat": null,
                  "post_delivery_tip_credit": null,
                  "preparation_status": 0,
                  "preparation_picked_up_time_actual": null,
                  "last_way_point_schedule": "2021-01-12T07:00:00.000Z",
                  "task_inventories": [],
                  "left_to_be_paid": null,
                  "preparation_end_time_planned": null,
                  "failed_delivery_attempts": 0,
                  "preparation_start_time_planned": null,
                  "cancellation_lng": null,
                  "accept_time": null,
                  "service_plan_id": null,
                  "preparation_start_time_actual": null,
                  "quote_id": null,
                  "title": "PEDIDO ZF",
                  "customer_id": 18847296,
                  "ended_time": null,
                  "external_id": "013-940071",
                  "extras": null,
                  "active_way_point_id": 24426916,
                  "user_id": 31317,
                  "status": 6,
                  "run_uuid": "c8338adb-2e9f-4440-88f0-d0e13f91cc2a",
                  "preparation_acknowledge_time_actual": "2021-01-11T15:15:32.000Z",
                  "discount": null,
                  "post_delivery_tip_cash": null,
                  "required_skills": [],
                  "parent_task_id": null,
                  "merchant_id": 178,
                  "created_at": "2021-01-11T15:15:32.000Z",
                  "task_type_id": null,
                  "distance_automatically_set": 0,
                  "scans": [],
                  "invalidated": false,
                  "distance_traveled": null,
                  "group_uuid": null,
                  "squad_uuid": null,
                  "fleet_delivery_external_id": null,
                  "group_leader_id": null,
                  "delete_at": null,
                  "total_price": null,
                  "virtual_task": false,
                  "planning_done": false,
                  "done_processing": false,
                  "started_time": null,
                  "acknowledged_at": "2021-01-11T15:15:32.000Z",
                  "task_configuration_id": null,
                  "start_preparation_at": null,
                  "automatically_started": 0,
                  "webhooks": null,
                  "preparation_ready_for_pickup_time_actual": null,
                  "start_lng": null,
                  "updated_at": "2021-01-12T09:41:10.000Z",
                  "start_lat": null,
                  "last_ready_to_execute_at": "2021-01-12T09:41:10.000Z",
                  "ready_to_execute": true,
                  "uuid": "810219f2-99a7-4538-9494-902f3cecc45a",
                  "price_before_tax": null,
                  "pre_delivery_tip": null,
                  "task_notes": [],
                  "last_way_point_lng": 2.1539369,
                  "squad_leader_id": null,
                  "origin_title": "Bringg Dashboard",
                  "tip": null,
                  "tax_price": null,
                  "automatically_assigned": false,
                  "automatically_cancelled": 0,
                  "preparation_ready_for_pickup_time_planned": null,
                  "way_points": [
                     {
                        "id": 24426916,
                        "lat": 41.3783128,
                        "lng": 2.1539369,
                        "task_id": 20174494,
                        "done": false,
                        "created_at": "2021-01-11T15:15:32.046Z",
                        "updated_at": "2021-01-11T15:15:32.046Z",
                        "customer_id": 18847296,
                        "address": "Gran Via de les Corts Catalanes, 442, Barcelona, Spain",
                        "position": 1,
                        "scheduled_at": "2021-01-12T07:00:00.000Z",
                        "checkin_time": null,
                        "checkout_time": null,
                        "note": null,
                        "find_me": null,
                        "asap": null,
                        "late": false,
                        "eta": null,
                        "etl": "2021-01-12T07:15:00.000Z",
                        "silent": false,
                        "phone": "+",
                        "email": "",
                        "delete_at": null,
                        "checkin_lat": null,
                        "checkin_lng": null,
                        "checkout_lat": null,
                        "checkout_lng": null,
                        "etos": 900,
                        "distance_traveled_client": null,
                        "distance_traveled_server": null,
                        "automatically_checked_in": 0,
                        "automatically_checked_out": 0,
                        "merchant_id": 178,
                        "start_lat": null,
                        "start_lng": null,
                        "start_time": null,
                        "estimated_distance": null,
                        "estimated_time": null,
                        "allow_editing_inventory": true,
                        "must_approve_inventory": false,
                        "address_second_line": "2º1ª",
                        "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": null,
                        "distance_traveled": null,
                        "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": [
                           18847296
                        ],
                        "contacts": [
                           {
                              "customer_id": 18847296,
                              "contact_type": "phone",
                              "contact_value": "+",
                              "sharing_allowed": false,
                              "opted_by_customer": false
                           }
                        ],
                        "allow_editing_original_quantity": null,
                        "pickup_dropoff_option": null,
                        "delivery_confirmation_cash": null,
                        "district": null,
                        "house_number": null,
                        "street": null,
                        "pending_geocode": null,
                        "original_eta": null,
                        "allow_automatic_set_coordinates": true,
                        "has_to_leave_by": null,
                        "extras": null,
                        "automatically_geocoded": true,
                        "original_etl": null,
                        "hidden": null,
                        "address_type": null,
                        "location_name": null,
                        "location_id": null,
                        "name": "POL LAFUENTE TERRAFETA",
                        "ui_data": null,
                        "first_attempt_promise_no_earlier_than": null,
                        "first_attempt_promise_no_later_than": null,
                        "driver_preparation_time": null,
                        "parking_spot_id": null,
                        "checkin_origin": null,
                        "checkout_origin": null,
                        "predicted_etos": null,
                        "customer": {
                           "id": 18847296,
                           "name": "POL LAFUENTE TERRAFETA",
                           "address": "Gran Via de les Corts Catalanes, 442, Barcelona, Spain",
                           "lat": 41.3783128,
                           "lng": 2.1539369,
                           "created_at": "2021-01-11T15:15:31.861Z",
                           "updated_at": "2021-01-11T15:15:31.861Z",
                           "phone": "+",
                           "merchant_id": 178,
                           "image": null,
                           "access_token": "161b5fef-41cb-428d-a85a-14e98bd904d8",
                           "confirmation_code": "2445",
                           "salt": null,
                           "approved": false,
                           "push_token": null,
                           "uuid": "1b640b9e-ac53-4edf-bad7-98de29b309f4",
                           "email": "",
                           "external_id": "18847296",
                           "delete_at": 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": "",
                           "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": true,
                           "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,
                           "address_type": null,
                           "tax_payer_external_id": null,
                           "tax_payer_name": null,
                           "rank": null,
                           "user_id": null,
                           "has_parking_area": null,
                           "driver_preparation_time": null
                        },
                        "answers": []
                     }
                  ],
                  "late": false,
                  "tip_driver_enabled": false,
                  "action_data": [],
                  "alerted_client_time": null,
                  "scheduled_to_be_ready": null,
                  "first_way_point_lng": 2.1539369,
                  "last_way_point_lat": 41.3783128,
                  "rank": null,
                  "linked_task_id": null,
                  "team_ids": [
                     3616
                  ],
                  "first_way_point_lat": 41.3783128,
                  "automatically_ended": 0,
                  "test": false,
                  "late_reason": null,
                  "left_to_be_paid_for_delivery": null,
                  "last_assigned_time": "2021-01-12T09:41:07.000Z",
                  "origin_id": 1389,
                  "delivery_window_id": null,
                  "run_id": 2408130,
                  "id": 20174494,
                  "shadow_task_id": null,
                  "planning_published": null,
                  "delivery_price": null
               }
            }
         ],
         "task_inventories": [],
         "scans": [],
         "task_notes": []
      }
   ],
   "webhook_type": "tasks_sent_to_driver",
   "merchant_id": 178
}

Output Params

updated_at

datetime

The timestamp when the webhook was triggered