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 Nov 07 2026 23:17:18 GMT+0000 (Coordinated Universal Time)",
  "failure": {
    "detail": "Invalid input parameter",
    "instance": "https://youthful-pile.info",
    "status": 412,
    "title": "Unauthorized",
    "type": "UnauthorizedException"
  },
  "note": "Critical update",
  "scope": "subscription.remove",
  "secret": "Q4DkbpbMVQKnfJgcu2LJDL1a8EHokQpc",
  "self": "https://bad-gerbil.net/"
}

GET

/subscription/{id}

Retrieve information about subscription

Request Payload

Response Payload

{
  "accountID": "5368705901",
  "events": [
    "delivered",
    "delivered",
    "delivered"
  ],
  "expires": "Thu Oct 22 2026 12:11:12 GMT+0000 (Coordinated Universal Time)",
  "failure": {
    "detail": "Unauthorized access",
    "instance": "https://cool-tuber.net/",
    "status": 506,
    "title": "Unauthorized",
    "type": "UnauthorizedException"
  },
  "format": "Default",
  "hook": {
    "uri": "https://pure-dandelion.org"
  },
  "note": "Regular push message",
  "scope": "subscription.ready",
  "secret": "fwciOym6c4EQpujcdT53ZF8OG61UwDI1",
  "self": "https://neglected-spear.biz/",
  "service": "express",
  "type": "AccountID"
}

{
  "detail": "Unauthorized access",
  "instance": "https://sandy-density.biz/",
  "status": 426,
  "title": "Not Found",
  "type": "NotFoundException"
}

POST

/subscription/{id}

Validation of intend request to activate already created Subscription

Header Name	Example
`DHL-API-Hook-Secret`*	`"labore et ut"`

Request Payload

Response Payload

{
  "expires": "Sun Feb 21 2027 18:42:57 GMT+0000 (Coordinated Universal Time)",
  "failure": {
    "detail": "Unauthorized access",
    "instance": "https://far-off-suspension.com/",
    "status": 508,
    "title": "Unauthorized",
    "type": "UnauthorizedException"
  },
  "note": "Subscription confirmation",
  "scope": "subscription.push",
  "secret": "Q1qTdkstMwDWNlzoBuPvx3JvYoSDMt88",
  "self": "https://kosher-precedent.org"
}

{
  "detail": "Invalid input parameter",
  "instance": "https://unripe-pilot.info/",
  "status": 501,
  "title": "Not Found",
  "type": "NotFoundException"
}

DELETE

/subscription/{id}

Remove already created subscription

Header Name	Example
`DHL-API-Hook-Secret`*	`"eu consectetur"`

Request Payload

Response Payload

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

{
  "detail": "Shipment not found",
  "instance": "https://general-flame.org/",
  "status": 508,
  "title": "Bad Request",
  "type": "UnauthorizedException"
}

GET

/subscriptions

Retrieve information about subscriptions

Request Payload

Response Payload

[
  {
    "accountID": "4678862874",
    "events": [
      "delivered"
    ],
    "expires": "Mon Oct 05 2026 06:19:05 GMT+0000 (Coordinated Universal Time)",
    "failure": {
      "detail": "Unauthorized access",
      "instance": "https://wasteful-manner.net",
      "status": 416,
      "title": "Unauthorized",
      "type": "ValidationException"
    },
    "format": "Default",
    "hook": {
      "uri": "https://honorable-festival.info/"
    },
    "note": "Subscription confirmation",
    "scope": "subscription.remove",
    "secret": "KDGEsfPN03eyxuK2hWP4kHDNXYHFcd8o",
    "self": "https://hospitable-bidet.biz/",
    "service": "express",
    "type": "AccountNumber"
  },
  {
    "accountID": "1489792963",
    "events": [
      "delivered",
      "delivered",
      "delivered"
    ],
    "expires": "Wed Mar 17 2027 17:40:01 GMT+0000 (Coordinated Universal Time)",
    "failure": {
      "detail": "Shipment not found",
      "instance": "https://glorious-moment.biz",
      "status": 425,
      "title": "Unauthorized",
      "type": "ValidationException"
    },
    "format": null,
    "hook": {
      "uri": "https://kosher-pick.com"
    },
    "note": "Regular push message",
    "scope": "subscription.remove",
    "secret": "PKRmIdDtO8ePt28ZphZfy92ptH0WjA4t",
    "self": "https://simplistic-chairperson.org",
    "service": "express",
    "type": "AccountID"
  },
  {
    "accountID": "8094224296",
    "events": [
      "delivered",
      "delivered"
    ],
    "expires": "Sun Dec 27 2026 01:35:42 GMT+0000 (Coordinated Universal Time)",
    "failure": {
      "detail": "Unauthorized access",
      "instance": "https://yellow-toaster.com",
      "status": 511,
      "title": "Not Found",
      "type": "NotFoundException"
    },
    "format": "parcel-de",
    "hook": {
      "uri": "https://common-wasabi.biz"
    },
    "note": "Subscription confirmation",
    "scope": "subscription.push",
    "secret": "bsZK3ZZ88cXfpfxnlvUCB0Ijaf5cCdAM",
    "self": "https://alarmed-boulevard.name/",
    "service": "express",
    "type": "AccountNumber"
  },
  {
    "events": [
      "delivered",
      "delivered",
      "delivered"
    ],
    "expires": "Sat Jun 05 2027 10:13:53 GMT+0000 (Coordinated Universal Time)",
    "failure": {
      "detail": "Shipment not found",
      "instance": "https://frilly-longboat.com/",
      "status": 406,
      "title": "Unauthorized",
      "type": "NotFoundException"
    },
    "format": "Default",
    "hook": {
      "uri": "https://pleasant-disconnection.com"
    },
    "note": "Regular push message",
    "scope": "subscription.ready",
    "secret": "d2nAX30S9KiPmxkbjT1yh4XJ2eX1w7YE",
    "self": "https://each-gift.net",
    "service": "express",
    "shipmentIDsWithChallengeDetails": [
      {
        "postalCode": "82441",
        "shipmentID": "YgFREfCCZ6"
      },
      {
        "postalCode": "06006-6995",
        "shipmentID": "wgnQBFNtP3"
      },
      {
        "postalCode": "23877",
        "shipmentID": "PrTpMOLOyW"
      }
    ],
    "type": "Pallet"
  }
]

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

dhllogisticstrackingwebhookpush