Skip to content
Consignments/
Proof of Delivery

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

Proof of DeliveryWebhook

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"
payloadArray of objects(ProofOfDeliveryDocuments)
payload[].​document_idstringrequired

The unique identifier for the proof of delivery document.

Example: "AB12C3"
payload[].​document_urlstring(uri)required

A time-limited URL to retrieve the proof of delivery document. The link remains active for 72 hours.

Example: "https://example.com/storage/document-with-unique-name.pdf?signature=sample-signature"
payload[].​file_typestringrequired

The file type of the proof of delivery document.

Enum"image/jpeg""image/png""application/pdf""image/svg+xml"
Example: "image/jpeg"
payload[].​proof_of_delivery_typestring<= 9 charactersrequired

The type of proof of delivery (e.g., image, signature).

Enum"image""signature"
Example: "signature"
payload[].​consignment_identifierstring<= 255 charactersrequired

The identifier of the consignment.

Example: "2154321"
payload[].​order_numberstring<= 255 charactersrequired

The order number of the consignment.

Example: "order-12345"
payload[].​package_tracking_numberstring<= 50 characters

Package tracking number. Optional; populated only if included by the carrier with the proof of delivery.

Example: "JD014600003281234567"
payload[].​package_referencestring<= 255 characters

The reference for the package.

Example: "ref-12345"
payload[].​carrierstring<= 64 charactersrequired

The name of the carrier who shipped the consignment.

Example: "DHL"
payload[].​service_idstring<= 128 charactersrequired

Service identifier (e.g., carrier and service name).

Example: "Generic Carrier|Next Day"
application/json
{
  "event_type": "proof_of_delivery",
  "event_id": "AB12C3",
  "payload_version": "2025.1",
  "payload": [
    { … }
  ]
}

Responses

Return a 200 response to acknowledge receipt of the webhook.

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