API Reference

Driver Unavailable Status Changed

This callback occurs when the driver notifies Bringg that they are temporarily unavailable to receive orders and when they return. For example, when a driver is dealing with a vehicle malfunction they will mark themselves as unavailable in the Driver App. When the repair is finished, they will mark themselves as available again. Learn more.

📘

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": 3287186,
    "name": "Timothee Chalamet",
    "status": "offline",
    "sub": "Assigned",
    "phone": +1(555)555-1234,
    "external_id": "3287186"
  },
  "user_available": true,
  "webhook_type": "driver_unavailable_status_changed",
  "merchant_id": 1
}

Output Params

id

Int32

Bringg's ID for the driver.

name

String

The driver's name

status

Int32

The driver's app status. The values are:

  • Offline
  • Online

sub

string

The driver's status. The values are:

  • Free - the driver can accept new orders.
  • Assigned - the driver has orders assigned to them that they did not start
  • Started - the driver is on the way to the order's first destination
  • Checked-In - the driver arrived at the order's destination
  • Late - Bringg calculates that the order will arrive late.

phone

string

The driver's phone number

external_id

String

Your ID for the driver.

user_available

Boolean

Indicates whether the driver is available to accept orders or not.