💡
Delivery API Guide
  • Introduction
  • The Basics
    • Set up your account
    • Base URLs
    • Authentication
    • Postman
    • Responses and Errors
    • Webhook Verification
    • Pagination
    • Rate Limiting
    • Session
  • Guides
    • Integrated Partners
    • Manual Partners
    • Connected Partners
    • Connected Platforms
    • Payments
    • Addresses and Locations
    • Delivery Statuses
    • Order Tracking
    • Common Terminology
    • Packaging
    • Pay on Delivery
    • Roles and Permissions
      • Associates
      • Operators
      • Admins
      • Super Admins
      • Tabular presentation
    • Websockets
  • Delivery Management APIs
    • Wallet
      • Get Wallet Balance
      • Get Wallet Transactions
    • Locations
      • Get Mapped Locations
      • Get Countries
    • Estimates
      • Get Delivery Price Estimate
    • Partners
      • Get Partners
      • Get Partner
      • Update Partner Profile
      • Add Partner Off Days
      • Delete Partner Off Day
    • Packaging
    • Categories
    • Bookings
      • New Booking
      • Generate POD account number
      • Fetch Deliveries
      • Update Delivery Details
      • Update Drop Statuses
      • Cancel Drops
      • Reschedule Delivery
      • Update Delivery Window
      • Assign Drop
    • Status Tracking
      • Track Delivery Status
    • Messaging
      • Send Customer Message
      • Add Private Note
      • Update note status
    • Sample Webhook Payloads
      • New delivery
      • Updated delivery status
      • New internal note
      • New customer message
      • Pickup attempt
      • Dropoff attempt
      • Pickup window updated
      • Delivery window updated
  • Live Tracking APIs
    • Devices
      • Get Devices
    • Positions
      • Get All Positions
      • Get Device Position History
      • Stream Positions
Powered by GitBook
On this page

Was this helpful?

  1. Guides

Websockets

Our websockets provide real-time data updates for your tracking devices, ensuring you stay informed as changes occur.

How It Works

  1. Authentication To initiate a WebSocket connection, a valid session must be included in the request query.

    • Learn how to generate a session ID here (link to detailed instructions).

  2. Websocket Connection Once connected, the websocket will stream real-time data for your tracking devices. Key details to note:

    • Data Streaming: Real-time updates are sent as long as the connection remains active.

    • Rate Limiting: A maximum of 2 responses per second is enforced to ensure optimal performance.

    • Update Triggers: Updates are only sent when there is a change in the status or location of at least one of your tracking devices.

  3. Getting Started For step-by-step instructions on connecting to the websocket, refer to our websocket connection guide (link to detailed instructions).

PreviousTabular presentationNextWallet

Last updated 1 day ago

Was this helpful?