API Reference

Order Reassigned with Reason

This callback is triggered when a dispatcher moves an order from one driver to another if the action requires the dispatcher to select a reassign reason (determined by configuration). When the dispatcher reassigns the order, they must select a reason (from a predefined list) and sometimes a descriptions that explains why they performed this change.

📘

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

{
  "task_reassign_reasons": {
    "id": 19,
    "task_id": 13456,
    "merchant_id": 1,
    "reason_to_reassign_task_id": 1,
    "created_at": "2023-02-18T19:33:30.818z",
    "updated_at": "2023-02-18T19:33:30.818z",
    "previous_driver_id": 23,
    "current_user_id": 890,
    "current_driver_id": 27,
    "text": "Original driver called out sick."
  },
  "current_user":{
   "id": 1234
  },
  "previous_driver":{
    "id":2456
  },
  "current_driver":{
    "id":2876
  },
  "task":{
    "id":34562
  },
  "reason_to_reassign_tasks":{
    "id":1,
    "mandatory_text":false,
    "reason":"Driver unable to continue with order"
  },
  "webhook_type": "task_reassign_reason_created",
  "merchant_id": 1,
}

Output Params

id

Int32

(Default field)Bringg's ID of the record.

task_id

Int32

(Default field) Bringg's ID for the order that was reassigned.

merchant_id

Int32

(Default field) Bringg's ID for the merchant.

reason_to_reassign_task_id

Int32

(Default field) Bringg's ID for the predefined reason why the order needed to be reassigned.

created_at

datetime

(Default field) The date and time this order was reassigned. Timezone - UTC, format "%Y-%m-%dT%H:%M:%S%z".

updated_at

datetime

(Default field) The date and time this order was reassigned. Timezone - UTC, format "%Y-%m-%dT%H:%M:%S%z".

previous_driver_id

Int32

(Default field) The ID of the driver the dispatcher moved the order assignment from.

current_user_id

Int32

(Default field) The ID of the dispatcher who reassigned the order.

current_driver_id

Int32

(Default field) The ID of the driver the dispatcher moved the order to.

text

string

(Default field) A description entered by the dispatcher to explain the reason for the assignment change.

current_user

object

Details regarding the dispatcher who reassigned the order. Can include any fields from the user object.

task

object

Details regarding the task that was reassigned. Can include any fields from the task object.

previous_driver

object

Details regarding the driver the order was previously assigned to. Can include any fields from the user object.

current_driver

object

Details regarding the driver the order was assigned to. Can include any fields from the user object.

mandatory_text

boolean

Defines whether the dispatcher is required to enter a description in addition to selecting a predefined reason for reassignment.

reason

string

The reason for reassignment.