DHL Webhook API Virtual Sandbox

Manage and automate pickup customer account webhooks for DHL tracking events.

The DHL Webhook API allows developers to programmatically manage notification endpoints for pickup customer accounts. It supports the creation, retrieval, updating, and deletion of webhook subscriptions to receive real-time updates on shipment tracking events.

Use this hosted sandbox to simulate DHL Webhook API 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 registration payloads, test event delivery triggers, verify signature verification logic, and handle retry or error scenarios for asynchronous tracking notifications without impacting production event streams.

DHL Webhook API virtual sandbox is up and running!

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

`https://dhl-webhooks.mock.beeceptor.com`

General(5 operations)

POST

/account/v4/webhooks

This endpoint allows you to create a new webhook registration for a specific pickup customer account. Only one webhook registration may be created per pickup customer account. Webhook callback URLs must use HTTPS. HTTP Basic Authentication is supported and recommended, but not required.

Header Name	Example
`User-Agent`	`"dolor ullamco nisi ea aliqua"`

Request Payload

{
  "active": true,
  "hookType": "TRACK_EVENTS",
  "password": "OaVIabI7yvzt",
  "pickup": "4@4+4@4",
  "trackingId": "1",
  "url": "https://joyful-wheel.org/",
  "username": "Zakary73"
}

Response Payload

{
  "active": true,
  "hookId": "5791f5bb-989c-4133-b9e3-98e12245f05a",
  "hookType": "TRACK_EVENTS",
  "password": "**",
  "pickup": "5234567",
  "trackingId": "9261290234835400877745",
  "url": "https://example.com/",
  "username": "abc123"
}

GET

/account/v4/webhooks

This endpoint allows you to retrieve a list of all webhooks owned by the current API credentials.

Header Name	Example
`User-Agent`	`"cillum in labore anim"`

Request Payload

Response Payload

{
  "webhooks": [
    {
      "active": true,
      "hookId": "c27d7042-f748-4785-b577-90be560dbb5a",
      "hookType": "TRACK_EVENTS",
      "password": "**",
      "pickup": "5234567",
      "url": "https://example.com/",
      "username": "abc123"
    },
    {
      "active": true,
      "hookId": "c27d7042-f748-4785-b577-90be560dbb5a",
      "hookType": "TRACK_EVENTS",
      "password": "**",
      "pickup": "5234567",
      "url": "https://example.com/",
      "username": "abc123"
    },
    {
      "active": true,
      "hookId": "c27d7042-f748-4785-b577-90be560dbb5a",
      "hookType": "TRACK_EVENTS",
      "password": "**",
      "pickup": "5234567",
      "url": "https://example.com/",
      "username": "abc123"
    },
    {
      "active": true,
      "hookId": "c27d7042-f748-4785-b577-90be560dbb5a",
      "hookType": "TRACK_EVENTS",
      "password": "**",
      "pickup": "5234567",
      "url": "https://example.com/",
      "username": "abc123"
    },
    {
      "active": true,
      "hookId": "c27d7042-f748-4785-b577-90be560dbb5a",
      "hookType": "TRACK_EVENTS",
      "password": "**",
      "pickup": "5234567",
      "url": "https://example.com/",
      "username": "abc123"
    }
  ]
}

{
  "title": "Invalid request",
  "type": "https://api-sandbox.dhlecs.com/docs/errors/400.0000003"
}

GET

/account/v4/webhooks/{hookId}

This endpoint allows you to retrieve information about a specific webhook, given the hookId.

Header Name	Example
`User-Agent`	`"ex mollit"`

Request Payload

Response Payload

{
  "active": true,
  "hookId": "c27d7042-f748-4785-b577-90be560dbb5a",
  "hookType": "TRACK_EVENTS",
  "password": "**",
  "pickup": "5234567",
  "url": "https://example.com/",
  "username": "abc123"
}

{
  "title": "No credentials provided",
  "type": "https://api-sandbox.dhlecs.com/docs/errors/401.0000008"
}

{
  "title": "Hook Not Found",
  "type": "https://api-sandbox.dhlecs.com/docs/errors/404.0404003"
}

PUT

/account/v4/webhooks/{hookId}

This endpoint allows you to modify a specific webhook, given the hookId. Note that the `hookId`, `pickup`, and `hookType` may not be modified.

Header Name	Example
`User-Agent`	`"Duis"`

Request Payload

{
  "active": true,
  "hookType": "TRACK_EVENTS",
  "password": "okuTgcFSk6Ic",
  "pickup": "6+6/6+6",
  "url": "https://mixed-quinoa.com/",
  "username": "Zena76"
}

Response Payload

{
  "active": true,
  "hookId": "c27d7042-f748-4785-b577-90be560dbb5a",
  "hookType": "TRACK_EVENTS",
  "password": "**",
  "pickup": "5234567",
  "url": "https://example.com/",
  "username": "abc123"
}

DELETE

/account/v4/webhooks/{hookId}

This endpoint allows you to delete a specific webhook, given the hookId.

Header Name	Example
`User-Agent`	`"culpa ex ad"`

Request Payload

Response Payload

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

{
  "title": "Internal gateway server error",
  "type": "https://api-sandbox.dhlecs.com/docs/errors/500.0000002"
}

Service Homepage: developer.dhl.com/api-reference/tracking-webhooks-dhl-ecommerce-americas#reference-docs-section

dhllogisticswebhookstrackingshipping