API Reference

Webhooks (BETA)

Overview

The Sendle Tracking Webhooks API allows users to subscribe to tracking event updates for orders associated with their account. Once subscribed, Sendle will POST tracking events to the specified listener URL whenever a new tracking update is created.

Beta Access

This feature is currently in beta. To gain access, please contact the Sendle Integration team.

How It Works

  1. Request access from the Sendle team. Once access is granted, proceed to the next steps.

  2. Navigate to the API tab in the Sendle dashboard settings.

  3. Enter your listener URL, including any necessary authentication details in the URL.

  4. Once enabled, all new tracking events for parcels associated with your account will be sent via HTTP POST to the specified listener URL.

  5. Sendle expects a successful HTTP response (status codes 2xx such as 200 or 201).

  6. If an error response is returned, Sendle will retry the delivery up to 3 times.

Webhook Payload

Each webhook payload contains a tracking event object structured as follows:

Tracking Event Schema

{
  "sendle_reference": "SAMPLE1",
  "event_id": "d72ef987-6699-4f01-b3a2-7292048c2a46",
  "description": "Parcel has been dropped off",
  "event_type": "Dropped off",
  "location_data": {
  	"suburb": "Eugene",
    "state": "OR",
    "postcode": "97405",
    "country": "US"
  },
  "scan_time": "2025-03-31T21:21:05Z"
}

Field Descriptions

  • sendle_reference (string, required): Unique reference for the order, can also be used to access the public tracking page. Sendle references begin with an "S" and are an alphanumeric string six or more characters in length.
  • event_id (uuid, required): The webhook event's unique identifier (UUID) in Sendle's system.
  • event_type (string, required): Type of scan event (e.g., Pickup, Info, Delivered). Complete list of event_types can be found here.
  • scan_time (string, required): Date and time of the scan event in UTC (RFC 3339 format).
  • description (string, required): Short description of the event.
  • location_data (object): Programmatic representation of the location.
    • suburb (string or null): Suburb or city of the scan.
    • state (string or null): State code where possible.
    • postcode (string or null): Postal code of the scan.
    • country (string or null): Country (ISO 3166-1 alpha-2 code or full name; ISO code preferred).

Example Usage

Once subscribed, you can expect webhook notifications for events such as:

  • Parcel pickup
  • In Transit updates
  • Delivery confirmation

For further details or to request access to the beta, please contact the Sendle Integration team.