Skip to content

Webhooks Specification (2025.1)

The Scurri Webhooks specification outlines the types 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

Consignments

Scurri supports sending Webhook notifications for specific consignment lifecycle events, allowing your system to react immediately to updates.

Currently, the following event is supported:

  • Proof of Delivery (POD): Triggered when Scurri successfully retrieves a proof of delivery document from a carrier. Please refer to the sections below for detailed payload specifications.
Webhooks

Tracking

Scurri supports sending Webhook notifications for specific tracking lifecycle events, allowing your system to react immediately to updates.

Currently, the following event is supported:

  • Tracking Update: Triggered when Scurri processes tracking updates received from carriers. Please refer to the sections below for detailed payload specifications.
Webhooks

Tracking UpdateWebhook

Request

Bodyapplication/json
event_typestring<= 255 charactersrequired

The type of event that triggered the webhook.

Example: "proof_of_delivery"
event_idstringrequired

A unique identifier for the event.

Example: "AB12C3"
payload_versionstring<= 10 charactersrequired

The version of the payload schema.

Example: "2025.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<= 50 charactersrequired

The tracking number of the package the tracking update is associated with.

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

The identifier of the consignment.

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

The consignment number of the consignment.

Example: "000000000008108293"
trackings[].​order_numberstringrequired

The order number of the consignment.

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

The internal parcel identifier from our tracking system.

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

The name of the carrier who provided this tracking update.

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

The status Scurri assigns to the tracking event.

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

A description of the tracking event.

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

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": "proof_of_delivery",
  "event_id": "AB12C3",
  "payload_version": "2025.1",
  "carrier_slug": "dhl",
  "count": 1,
  "trackings": [
    { … }
  ]
}

Responses

Return a 200 response to acknowledge receipt of the webhook.