---
title: "Tracking Webhook Push Payload Example"
method: POST
path: "/v4/trackings/PushPayloadExample"
tags: ["Trackings"]
---

# Tracking Webhook Push Payload Example

`POST /v4/trackings/PushPayloadExample`

Example of the tracking webhook push notification payload, as sent to a customer's webhook when tracking information is received from a carrier.
<br />For a webhook push notification to be triggered, the tracking number must be registered with SAPIENT and a tracking account and tracking webhook must be configured.
<br />
<br />*Note: this is an example of what SAPIENT posts to the customer, it is not a functioning API endpoint.*

## Request body

- ShipmentTrackingWebhookPushPayload[]
  - `TrackingNumber` string, required — Tracking Number
  - `ShipmentId` string, uuid, required — Shipment Id <br />The shipment identifier as returned from creating shipments or from the trackings API endpoint.
  - `ShipperReference` string — Shipper Reference <br />The shipper reference, as provided at the time the shipment was created or registered with the trackings API endpoint, or from the tracking event information (if available) if not supplied on shipment creation.
  - `CarrierCode` string, required — Carrier Code
  - `Milestone` string — Milestone <br />Either an empty string if the tracking event does not correspond to a milestone and no milestones have been triggered for the shipment, or else one of the following: <br /> <br />- COLLECTED <br />- DELIVERED <br />- DELIVERY ATTEMPT FAILED <br />- IN CUSTOMS <br />- IN TRANSIT <br />- IT'S ON IT'S WAY <br />- OUT FOR DELIVERY <br />- PART DELIVERED <br />- READY FOR COLLECTION <br />- TRANSIT DELAY <br />- UNDELIVERABLE
  - `MilestoneDateTime` string — Milestone Date/Time <br />Either an empty string if the tracking event does not correspond to a milestone and no milestones have been triggered for the shipment, or the milestone date and time. <br />Format: YYYY-MM-DD HH:MM:SS
  - `Events` ShipmentTrackingWebhookPushPayloadEvent[], required — Events
    - `EventId` string, uuid, required — Event Id <br />A unique identifier for the tracking event
    - `EventType` string, required — Event Type <br />One of the following: <br /> <br />- Delivery (if a final event) <br />- Milestone (if a tracking event that triggered a change of milestone) <br />- Tracking
    - `EventCode` 'BCUI' | 'BHBC' | 'BRBC' | 'CAAT' | 'CAFA' | 'CAFI' | 'CAFN' | 'CAFO' | 'CAFP' | 'CAMD' | 'CCAN' | 'CDNO' | 'CNAT' | 'COMM' | 'CSBK' | 'CSNO' | 'CSPI' | 'CSPN' | 'CSPO' | 'CSPP' | 'DDMG' | 'DELV' | 'DNSO' | 'DNSV' | 'DPAR' | 'DPOB' | 'DRCO' | 'DRFC' | 'DTNB' | 'DTNS' | 'DTSP' | 'EXPD' | 'FANK' | 'FCAR' | 'FDAF' | 'FINA' | 'FNCO' | 'FRAA' | 'FRNK' | 'FUDS' | 'FUTA' | 'ICAN' | 'IDAS' | 'IDES' | 'IDIP' | 'IARR' | 'ICLR' | 'IRCO' | 'IFME' | 'IMID' | 'INVD' | 'IOWS' | 'ISMI' | 'ISOH' | 'PINT' | 'POFD' | 'PPID' | 'PRET' | 'PRID' | 'PSAN' | 'PSCO' | 'PSCS' | 'PSDD' | 'PSDE' | 'PSDP' | 'PSRE' | 'RNCO' | 'RTNS' | 'RUND' — Event Code <br />Only supplied if the tracking webhook is configured to receive Full Tracking Events.
    - `EventDescription` string, required — Event Description
    - `EventDateTime` string, required — Event Date/Time <br />Format: YYYY-MM-DD HH:MM:SS
    - `EventUtcOffset` string — Event UTC Offset <br />The UTC offset of the event date/time, if provided by the carrier.
    - `EventLocation` ShipmentTrackingWebhookPushPayloadEventLocation, required — Shipment Tracking Webhook Push Payload Event Location
      - `Location` string — Location
      - `CountryCode` string — Country Code

## Response `200`

Success

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.dev/intersoftsapient/apis/sapient-core-api.md) · [All operations](https://skmtc.dev/intersoftsapient/apis/sapient-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intersoftsapient/sapient-core-api/revisions/3315ad0b5875/schema)