Skip to content

Consignments

Receive webhook notifications for supported consignment events, so your system can react in real time.

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 Delivery
Webhook

Request

Triggered when Scurri retrieves a Proof of Delivery document from a carrier. The payload includes a direct link to retrieve the file, and extra consignment related information.

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)
POST
ProofOfDelivery
Payload
{
  "event_type": "proof_of_delivery",
  "event_id": "AB12C3",
  "payload_version": "2025.1",
  "payload": [
    { … }
  ]
}

Responses

Return a 200 response to acknowledge receipt of the webhook.