Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.usedroptrail.com/llms.txt

Use this file to discover all available pages before exploring further.

Connect via WebSocket to receive instant updates about a delivery’s location and status changes without polling.

Path Parameters

id
string
required
The unique identifier of the delivery request to track

Connection

The WebSocket connection will remain open until either party closes it. The server will send updates whenever the delivery’s location or status changes.

Message Format

Updates are sent as JSON messages with the following structure:
type
string
Type of update (LOCATION_UPDATE, STATUS_CHANGE)
delivery_id
string
The unique identifier of the delivery request
timestamp
string
ISO 8601 timestamp when the update occurred
data
object
Update details

Example Messages

Location Update