Payload Structure

Payload Structure

When an event triggers, Kvikk sends the following JSON payload in the body of the POST request:

{
  "tracking": {
    "dispatched": "2024-12-08T18:21:47.375Z",
    "shipped": true,
    "delivered": true,
    "returned": false,
    "updated": "2024-12-08T18:56:34.036Z",
    "events": [
      {
        "event": "delivered",
        "message": "",
        "location": "",
        "date": "2024-12-05T16:45:52.000Z",
        "_id": "6755ebe27f92cdad974f10b6",
        "id": "6755ebe27f92cdad974f10b6"
      },
      ...
    ]
  },
  "dispatchAddress": {
    "address": "Test u. 6.",
    "city": "Test",
    "postcode": "1234",
    "name": "Test User",
    "phone": "+36301234567",
    "email": "[email protected]",
    "country": "HU",
    "_id": "6738a20296ffda42a6ce3ed3"
  },
  "name": "Test User",
  "phone": "+36301234567",
  "email": "[email protected]",
  "courier": "packeta",
  "orderID": "123",
  "weight": 1000,
  "cod": 0,
  "value": 1,
  "note": "Test",
  "trackingNumber": "P317647395664",
  "courierTrackingNumber": "12345678",
  "created": "2024-11-16T13:45:38.742Z",
  "deliveryPointType": "zbox",
  "deliveryPointID": "26734",
  "shippingAddress": {
    "coordinates": {
      "lat": 47.03795,
      "lon": 18.01996
    },
    "address": "Fűzfői út 5.",
    "city": "Balatonalmádi",
    "postcode": "8220",
    "name": "Z-BOX",
    "country": "HU",
    "_id": "6738a20296ffda42a6ce3ed4"
  },
  "courierTrackingLink": "https://tracking.packeta.com/hu/?id=1349185607",
  "trackingLink": "https://tracking.kvikk.hu/#/P317647395664",
  "labelDownloadLink": "http://assets.kvikk.hu/download/?file=2024%2F11%2Fd0fb666e8224b6ad.pdf&token=b84cacd83dea5f6ecc8433d597c8a350%3A3158a9524f0a5d782a9afb3bd18ff04345d50f103da8f7663bcf7c82dc1073c05575dfe658d95c75e537a80fb9dc343d",
  "appLink": "http://app.kvikk.hu/shipments/6738a20296ffda42a6ce3ed2",
  "id": "6738a20296ffda42a6ce3ed2"
}

Headers Included

• kvikk-webhook-event: Specifies the event type (e.g., delivered, shipped).
• kvikk-webhook-signature: HMAC-SHA256 signature to verify the payload's authenticity.

Supported Event Types

Event ID	Description
dispatched	Shipment dispatched from the sender.
shipped	Shipment picked up or dropped off for delivery.
delivered	Shipment successfully delivered.
returned	Shipment returned to the sender.