DHL UTAPI Push Webhook Virtual Sandbox

Reliable push notifications for shipment tracking events.

The Push API enables sending push messages to an application via a push service. It ensures reliable delivery of shipment updates to a target system, allowing applications to update local state or display notifications even when the application is inactive. Supports ISO 8601 date and time formats for all shipment events.

Use this hosted sandbox to simulate DHL UTAPI Push Webhook APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready. This keeps your integration code consistent across local development, QA, demos, and production.

Use cases:

Use this sandbox to validate webhook subscription flows, test payload delivery for shipment status updates, verify ISO 8601 timestamp parsing, and simulate error handling for delivery failures between the DHL push service and your target application endpoint.

DHL UTAPI Push Webhook virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate DHL UTAPI Push Webhook responses instantly.

`https://dhl-utapi-push.mock.beeceptor.com`

Subscriber(5 operations)

POST

/subscription

Create request to register subscription for `Account` or `Shipment`.

Request Payload

{
  "hook": {
    "uri": "https://webhook123.mydomain.com/track/push"
  },
  "format": "Default",
  "type": "Shipment",
  "service": "sameday",
  "events": [
    "Transit"
  ],
  "shipmentIDs": [
    "1829852058",
    "1829852059"
  ]
}

Response Payload

{
  "expires": "Sat Jul 25 2026 13:15:38 GMT+0000 (Coordinated Universal Time)",
  "failure": {
    "detail": "Invalid input parameter",
    "instance": "https://measly-midwife.org/",
    "status": 501,
    "title": "Not Found",
    "type": "ValidationException"
  },
  "note": "Regular push message",
  "scope": "subscription.failure",
  "secret": "i5b65gX4CC3j6E8OO6NuQJoQuQelx6c9",
  "self": "https://pitiful-spork.info"
}

GET

/subscription/{id}

Retrieve information about subscription

Request Payload

Response Payload

{
  "events": [
    "delivered",
    "delivered",
    "delivered"
  ],
  "expires": "Wed Jul 08 2026 09:48:22 GMT+0000 (Coordinated Universal Time)",
  "failure": {
    "detail": "Shipment not found",
    "instance": "https://faraway-rationale.org",
    "status": 500,
    "title": "Not Found",
    "type": "UnauthorizedException"
  },
  "format": null,
  "hook": {
    "uri": "https://excited-minion.com"
  },
  "note": "Subscription confirmation",
  "scope": "subscription.failure",
  "secret": "6rBYmX4pJ6Dmju7KjN9OO6oc8hzjyple",
  "self": "https://bruised-seafood.com/",
  "service": "express",
  "shipmentIDs": [
    "9988776655",
    "1122334455"
  ],
  "type": "TrackingNumber"
}

{
  "detail": "Invalid input parameter",
  "instance": "https://afraid-swanling.name/",
  "status": 425,
  "title": "Not Found",
  "type": "ValidationException"
}

POST

/subscription/{id}

Validation of intend request to activate already created Subscription

Header Name	Example
`DHL-API-Hook-Secret`*	`"quis dolore sint in qui"`

Request Payload

Response Payload

{
  "expires": "Thu Sep 24 2026 10:07:17 GMT+0000 (Coordinated Universal Time)",
  "failure": {
    "detail": "Invalid input parameter",
    "instance": "https://violent-mantua.net/",
    "status": 507,
    "title": "Bad Request",
    "type": "UnauthorizedException"
  },
  "note": "Subscription confirmation",
  "scope": "subscription.activate",
  "secret": "o6iwLWy5kWu6Vo2bopO6wDtBMdQpAqYN",
  "self": "https://muted-honesty.name"
}

{
  "detail": "Invalid input parameter",
  "instance": "https://grimy-cafe.biz",
  "status": 505,
  "title": "Bad Request",
  "type": "ValidationException"
}

DELETE

/subscription/{id}

Remove already created subscription

Header Name	Example
`DHL-API-Hook-Secret`*	`"aliquip nostrud voluptate"`

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "detail": "Invalid input parameter",
  "instance": "https://spiffy-hyena.org/",
  "status": 505,
  "title": "Bad Request",
  "type": "UnauthorizedException"
}

GET

/subscriptions

Retrieve information about subscriptions

Request Payload

Response Payload

[
  {
    "accountID": "3311509152",
    "events": [
      "delivered",
      "delivered",
      "delivered",
      "delivered",
      "delivered"
    ],
    "expires": "Wed Apr 07 2027 11:08:00 GMT+0000 (Coordinated Universal Time)",
    "failure": {
      "detail": "Unauthorized access",
      "instance": "https://obedient-ostrich.info/",
      "status": 506,
      "title": "Not Found",
      "type": "ValidationException"
    },
    "format": "parcel-de",
    "hook": {
      "uri": "https://married-promise.org/"
    },
    "note": "Critical update",
    "scope": "subscription.ready",
    "secret": "Xi5iwHQKdzv4wAbdjNBY6fmTFi1fceIU",
    "self": "https://dependent-electronics.net",
    "service": "express",
    "type": "AccountNumber"
  },
  {
    "accountID": "5868223222",
    "events": [
      "delivered",
      "delivered",
      "delivered",
      "delivered",
      "delivered"
    ],
    "expires": "Sun Feb 07 2027 19:41:32 GMT+0000 (Coordinated Universal Time)",
    "failure": {
      "detail": "Unauthorized access",
      "instance": "https://scratchy-doing.biz/",
      "status": 510,
      "title": "Not Found",
      "type": "NotFoundException"
    },
    "format": null,
    "hook": {
      "uri": "https://rowdy-plumber.info"
    },
    "note": "Subscription confirmation",
    "scope": "subscription.push",
    "secret": "RsY6719rQWcu3LeFS9O3V9IkYx6KOQUr",
    "self": "https://crazy-patroller.biz/",
    "service": "express",
    "type": "AccountID"
  },
  {
    "accountID": "4196523342",
    "events": [
      "delivered",
      "delivered",
      "delivered",
      "delivered"
    ],
    "expires": "Sun Feb 07 2027 21:51:30 GMT+0000 (Coordinated Universal Time)",
    "failure": {
      "detail": "Shipment not found",
      "instance": "https://wicked-tabletop.name",
      "status": 407,
      "title": "Bad Request",
      "type": "NotFoundException"
    },
    "format": "parcel-de",
    "hook": {
      "uri": "https://baggy-defendant.biz"
    },
    "note": "Critical update",
    "scope": "subscription.ready",
    "secret": "hh1r11YQMjtFjxWCtMq421nkvXYYYXr5",
    "self": "https://caring-intent.info/",
    "service": "express",
    "type": "AccountID"
  }
]

Service Homepage: developer.dhl.com/api-reference/shipment-tracking-unified-push#reference-docs-section

dhllogisticstrackingwebhookpush