Dispatch Module
POST https://webhook.example.com
application/json

Body

status updates for a dispatch id

  • payload_type string

    type of payload received

    Value is driver_assigned.

  • payload object
    Hide payload attributes Show payload attributes object
    • id string

      uniques identifier for a dispatch

    • status string

      status of a dispatch

      Value is assigned.

    • status_captured_time string

      timestamp of when the dispatch was updated

    • ref_id string

      unique identifier represented by ref_type

    • ref_type string

      actor/resource type

    • vendor_oid string

      unique order identifier

    • vendor_sid string

      unique short readable identifier

    • vendor_id string

      Restaurant unique identifier

    • driver_details object

      assigned driver user details

      Hide driver_details attributes Show driver_details attributes object
      • phone string

        phone/mobile number of the driver

      • firstName string

        first name of the driver

      • lastName string

        last name of the driver

Responses

  • 200

    Return a 200 status to indicate that the data was received successfully

POST driverAssigned
Request examples 
{
  "payload_type": "driver_assigned",
  "payload": {
    "id": "01HQ0PV32FMRA1XGT609QFV2VJ",
    "status": "assigned",
    "status_captured_time": "2024-02-28 12:05:24.992",
    "ref_id": "01HQ0PV32FMRA1XGT609QFV2VJ",
    "ref_type": "user",
    "vendor_oid": "15ed2668-f118-40c3-a52c-8ad90fe11ed7",
    "vendor_sid": "15EEDFRG",
    "vendor_id": "15ed2668-f118-40c3-a52c-8ad90fe11ed7",
    "driver_details": {
      "phone": "+9665987654321",
      "firstName": "John",
      "lastName": "Doe"
    }
  }
}