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 status_update.

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

      uniques identifier for a dispatch

    • status string

      status of a dispatch

      Values are accepted, new, picked_up, assigned, ready_for_pickup, dispatch_rejected, dispatch_accepted, cancelled, qa_qc, delivered, near_pickup, or near_destination.

    • 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

    • assigned_driver_id string

      driver_id assigned to the dispatch

    • fleet_id string

      fleet_id of the driver assigned

Responses

  • 200

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

POST statusUpdates
Request examples 
{
  "payload_type": "status_update",
  "payload": {
    "id": "01HQ0PV32FMRA1XGT609QFV2VJ",
    "status": "accepted",
    "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",
    "assigned_driver_id": "01HQ0PV32FMRA1XGT609QFV2VJ",
    "fleet_id": "01HQ0PV32FMRA1XGT609QFV2VJ"
  }
}