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 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.
Subscriber(5 operations)
{
"hook": {
"uri": "https://webhook123.mydomain.com/track/push"
},
"format": "Default",
"type": "Shipment",
"service": "sameday",
"events": [
"Transit"
],
"shipmentIDs": [
"1829852058",
"1829852059"
]
}{
"expires": "Sat Oct 24 2026 10:29:27 GMT+0000 (Coordinated Universal Time)",
"failure": {
"detail": "Unauthorized access",
"instance": "https://gaseous-fedora.biz/",
"status": 503,
"title": "Bad Request",
"type": "ValidationException"
},
"note": "Subscription confirmation",
"scope": "subscription.activate",
"secret": "oVmJ9apzwMmUsmC1sKOcqKevBwoOJjZf",
"self": "https://husky-veto.com/"
}{
"accountID": "5394997464",
"events": [
"delivered",
"delivered",
"delivered",
"delivered",
"delivered"
],
"expires": "Sat Jan 30 2027 03:13:05 GMT+0000 (Coordinated Universal Time)",
"failure": {
"detail": "Shipment not found",
"instance": "https://burly-trick.info",
"status": 502,
"title": "Bad Request",
"type": "NotFoundException"
},
"format": "Default",
"hook": {
"uri": "https://salty-hope.biz"
},
"note": "Subscription confirmation",
"scope": "subscription.ready",
"secret": "DcBcZRiAhhP3qXOpYURaPDfcEIH2mZmG",
"self": "https://limping-remark.name",
"service": "express",
"type": "AccountID"
}{
"detail": "Unauthorized access",
"instance": "https://exalted-jury.name/",
"status": 410,
"title": "Not Found",
"type": "UnauthorizedException"
}| Header Name | Example |
|---|---|
DHL-API-Hook-Secret* | "ut incididunt aliqua" |
{
"expires": "Thu Jul 22 2027 10:38:36 GMT+0000 (Coordinated Universal Time)",
"failure": {
"detail": "Shipment not found",
"instance": "https://shady-redesign.biz",
"status": 426,
"title": "Bad Request",
"type": "UnauthorizedException"
},
"note": "Critical update",
"scope": "subscription.validate",
"secret": "h8SqwcqCEQLHEP3yg2ZN7yhvtnJvzURj",
"self": "https://impish-crest.info/"
}{
"detail": "Shipment not found",
"instance": "https://vivid-conservation.name/",
"status": 423,
"title": "Not Found",
"type": "NotFoundException"
}| Header Name | Example |
|---|---|
DHL-API-Hook-Secret* | "laborum pariatur et ad" |
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"detail": "Invalid input parameter",
"instance": "https://lavish-daddy.info",
"status": 406,
"title": "Bad Request",
"type": "UnauthorizedException"
}[
{
"events": [
"delivered",
"delivered"
],
"expires": "Thu Jan 14 2027 08:50:13 GMT+0000 (Coordinated Universal Time)",
"failure": {
"detail": "Unauthorized access",
"instance": "https://early-valuable.org",
"status": 429,
"title": "Bad Request",
"type": "UnauthorizedException"
},
"format": "parcel-de",
"hook": {
"uri": "https://alert-meadow.org/"
},
"note": "Critical update",
"scope": "subscription.ready",
"secret": "vd9GPVlKFyeVMKtHKPuuBGEEiBv0gEv3",
"self": "https://muted-dependency.net/",
"service": "express",
"shipmentIDs": [
"1234567890",
"9988776655",
"5544332211",
"0987654321",
"1122334455"
],
"type": "TrackingNumber"
},
{
"accountID": "6540342472",
"events": [
"delivered",
"delivered",
"delivered"
],
"expires": "Fri Jul 02 2027 17:03:40 GMT+0000 (Coordinated Universal Time)",
"failure": {
"detail": "Shipment not found",
"instance": "https://limping-cross-contamination.org/",
"status": 451,
"title": "Unauthorized",
"type": "NotFoundException"
},
"format": "parcel-de",
"hook": {
"uri": "https://lost-interviewer.com/"
},
"note": "Subscription confirmation",
"scope": "subscription.remove",
"secret": "wRdVbHIP10o0qkzkFkL3TScdlE8fIW3S",
"self": "https://productive-boulevard.biz",
"service": "express",
"type": "AccountNumber"
},
{
"events": [
"delivered",
"delivered",
"delivered",
"delivered",
"delivered"
],
"expires": "Fri Jan 08 2027 21:51:34 GMT+0000 (Coordinated Universal Time)",
"failure": {
"detail": "Invalid input parameter",
"instance": "https://ideal-pilot.org/",
"status": 408,
"title": "Bad Request",
"type": "UnauthorizedException"
},
"format": "Default",
"hook": {
"uri": "https://lost-makeover.info"
},
"note": "Subscription confirmation",
"scope": "subscription.push",
"secret": "ZqCH7p4Wt63Gc0QzphEidyzdyecmKWX8",
"self": "https://dense-monster.info/",
"service": "express",
"shipmentIDs": [
"1234567890",
"9988776655",
"1122334455"
],
"type": "TrackingNumber"
},
{
"events": [
"delivered",
"delivered",
"delivered"
],
"expires": "Thu Jan 21 2027 12:27:38 GMT+0000 (Coordinated Universal Time)",
"failure": {
"detail": "Unauthorized access",
"instance": "https://unripe-jungle.net/",
"status": 405,
"title": "Unauthorized",
"type": "NotFoundException"
},
"format": "parcel-de",
"hook": {
"uri": "https://gripping-priesthood.biz/"
},
"note": "Regular push message",
"scope": "subscription.remove",
"secret": "xXqeMXtO2FMoF56XfrvZYoG2omddKeAT",
"self": "https://immaculate-hierarchy.org/",
"service": "express",
"shipmentIDsWithChallengeDetails": [
{
"postalCode": "49323",
"shipmentID": "Vd0SwvrfWX"
},
{
"postalCode": "44329-1904",
"shipmentID": "VqiWZS1IQH"
},
{
"postalCode": "33015",
"shipmentID": "n6whfCjlbU"
},
{
"postalCode": "74346-0508",
"shipmentID": "g0aWZ1AEOG"
},
{
"postalCode": "87774",
"shipmentID": "H02UyzB4qn"
}
],
"type": "Pallet"
},
{
"events": [
"delivered",
"delivered",
"delivered",
"delivered"
],
"expires": "Wed Feb 10 2027 02:00:41 GMT+0000 (Coordinated Universal Time)",
"failure": {
"detail": "Invalid input parameter",
"instance": "https://troubled-fibre.info",
"status": 506,
"title": "Unauthorized",
"type": "ValidationException"
},
"format": "Default",
"hook": {
"uri": "https://shrill-derby.net"
},
"note": "Regular push message",
"scope": "subscription.validate",
"secret": "3IjISMNlqFcfrnAKkWm7nD7yIELjGwpO",
"self": "https://humiliating-stir-fry.org/",
"service": "express",
"shipmentIDs": [
"9988776655",
"0987654321"
],
"type": "TrackingNumber"
}
]