Event Types

This parameter specifies during which event the relevant webhook request will be triggered and transmitted.

• Enum Class Name: WebhookSubscribedEvent
• Parameter Name: subscribedEvent

These values can be used both when creating webhooks and when responding. You can integrate them into your own system to enhance integration and comprehensibility.

Webhook Payload Examples

Below are example payloads that the webhook will send to your system for each event type.

consignment.status.updated

Triggered when consignment status is updated.

{
  "headers": {
    "Authorization": "__YOUR_AUTH_KEY__",
    "Content-Type": "application/json"
  },
  "body": {
    "event": "consignment.status.updated",
    "data": {
      "consignmentId": 3396107,
      "consignmentUuid": "8378bbe5-b66c-4048-bf9d-b4cd52469bec",
      "barcode": "C2H04729482615",
      "referenceNo": "KPTT1661447TDBZP",
      "location": null,
      "status": 1,
      "statusMessage": "Consignment sent to provider",
      "statusUpdatedAt": "2025-10-31 13:09:16.903467",
      "lastTrackingCode": "KPTT1661447TDBZP",
      "createdAt": "2025-10-31 13:09:16.903467",
      "events": [
        {
          "status": 1,
          "statusMessage": "Consignment sent to provider",
          "statusUpdatedAt": "2025-10-31 13:09:16.903467",
          "location": null
        }
      ],
      "labels": []
    }
  }
}

consignment.label.created

Triggered when a new label is added to the consignment.

{
  "headers": {
    "Authorization": "__YOUR_AUTH_KEY__",
    "Content-Type": "application/json"
  },
  "body": {
    "event": "consignment.label.created",
    "data": {
      "consignmentId": 3393215,
      "consignmentUuid": "8f5ad2c9-3a2a-4e7d-a858-d1b9e17fd15d",
      "barcode": "KP05917924760",
      "referenceNo": "EPTT898824753",
      "trackingCode": "KP05917924760",
      "trackingType": 1,
      "provider": "Ptt",
      "createdAt": "2025-10-31 13:09:16.903467",
      "updatedAt": "2025-10-31 13:09:16.903467",
      "base64label": "__BASE64_DATA__"
    }
  }
}

consignment.size.updated

Triggered when consignment size information is updated.

{
  "headers": {
    "Authorization": "__YOUR_AUTH_KEY__",
    "Content-Type": "application/json"
  },
  "body": {
    "event": "consignment.size.updated",
    "data": {
      "consignmentId": 3393215,
      "consignmentUuid": "8f5ad2c9-3a2a-4e7d-a858-d1b9e17fd15d",
      "barcode": "C2H11294525102",
      "referenceNo": "EPTT898824753",
      "weight": 0.5,
      "length": 0,
      "width": 0,
      "height": 0,
      "desi": 1,
      "lastTrackingCode": "KP05917924760",
      "createdAt": "2025-10-31 13:09:16.903467",
      "updatedAt": "2025-10-31 13:09:16.903467",
      "events": [
        {
          "status": 1,
          "statusMessage": "Consignment sent to provider",
          "statusUpdatedAt": "2025-10-31 13:09:16.903467",
          "location": null
        },
        {
          "status": 2,
          "statusMessage": "Kabul Edildi",
          "statusUpdatedAt": "2025-10-31 13:09:16.903467",
          "location": "SAKARYA PKİM/SAKARYA PKİM"
        }
      ],
      "statusMessage": "Kabul Edildi",
      "status": 2
    }
  }
}