Skip to content

Webhooks Specification (2024.1)

The Scurri Webhooks specification outlines the kinds of events for which webhooks can be triggered from the Scurri platform. Each definition includes a description of when an event is triggered and the payload that will be sent to the configured endpoint.

Configuration of webhooks can be managed via the webhooks dashboard on the Scurri UI.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://docs.scurri.com

Tracking

Webhooks related to tracking

Webhooks

Tracking UpdateWebhook

Request

Bodyapplication/json
event_typestring

The type of event that triggered the webhook.

Example: "tracking_update"
event_idstring

A unique identifier for the event.

Example: "AB12C3"
payload_versionstring

The version of the payload schema.

Example: "2024.1"
carrier_slugstring<= 50 characters

The slug of the carrier that provided the tracking update.

Example: "dhl"
countinteger

The number of packages (tracking updates) in the response.

Example: 1
trackingsArray of objects(TrackingUpdates)
trackings[].​tracking_numberstring

The tracking number the tracking update is associated with.

Example: "JD014600003281234567"
trackings[].​consignment_identifierstring<= 255 characters

The identifier of the consignment to which this tracking update applies.

Example: "ab12345"
trackings[].​consignment_numberstring<= 255 characters

The consignment number of the consignment to which this tracking update applies.

Example: "JD014600003281234567"
trackings[].​order_numberstring

The order number of the consignment to which this tracking update applies.

Example: "order-12345"
trackings[].​idinteger

The internal parcel identifier from our tracking system.

Example: 1234567890
trackings[].​carrierstring<= 50 characters

The name of the carrier who provided this tracking update.

Example: "DHL"
trackings[].​eventsArray of objects(Events)
trackings[].​events[].​statusstring<= 25 characters

The status Scurri assigns to the tracking event, in capitalized format.

Example: "Delivered"
trackings[].​events[].​descriptionstring<= 500 characters

A description of the tracking event.

Example: "The package was delivered to the recipient."
trackings[].​events[].​timestampstring

The timestamp when the tracking event occurred.

Example: "2025-10-01T14:30:00"
trackings[].​events[].​carrier_codestring<= 50 characters

The event code provided by the carrier.

Example: "EVD"
trackings[].​events[].​locationstring<= 255 characters

The location where the event took place.

Example: "London"
application/json
{
  "event_type": "tracking_update",
  "event_id": "AB12C3",
  "payload_version": "2024.1",
  "carrier_slug": "dhl",
  "count": 1,
  "trackings": [
    { … }
  ]
}

Responses

Return a 200 response to acknowledge receipt of the webhook.