API Integration

Learn how to set up API keys and configure third-party integrations for shipping providers. The platform provides integrations with DHL eCommerce and PostNL for automated shipping and live tracking.

Overview

The platform offers integrations with external shipping providers that allow you to automatically create shipping labels and receive live tracking updates. Configure your shipping provider credentials under Company Settings to get started.

For shipping, you can use the API keys from your shipping provider to automatically create shipping labels and track your shipments.

DHL Pusher (Live Tracking Updates)

DHL Pusher enables automatic, real-time tracking updates for your DHL shipments. Instead of manually checking tracking status, DHL sends updates directly to the platform whenever a shipment status changes.

Tip: Once DHL Pusher is enabled, all new shipments are automatically subscribed to live tracking. You can see tracking update events directly in each claim's timeline.

How It Works

DHL sends tracking updates to a secure webhook URL registered to your company
The platform receives these updates and automatically updates the shipment status
Tracking events appear in the claim timeline without any manual action
New shipments are automatically subscribed to receive updates when tracking is first checked

Setup Process

Setting up DHL Pusher is a two-step process between the platform and your DHL account:

Step 1: Generate Credentials on the Platform

Go to Settings → Integrations → DHL Pusher
Copy the Webhook URL shown on the page (use the Copy button)
Click "Generate auth key" to create a secure authentication key
Copy the generated Webhook Auth Key

Step 2: Configure DHL Track & Trace Pusher

Log in to your DHL Track and Trace Pusher account
Paste the Webhook URL from Step 1
Paste the Webhook Auth Key from Step 1
Set the API key header to "Authorization"
Save the configuration in DHL
DHL will provide you with a Subscription Key and a Configuration ID

Step 3: Complete Setup on the Platform

Return to Settings → Integrations → DHL Pusher
Enter the Subscription Key from DHL
Enter the Configuration ID from DHL
Click "Save Configuration"

Important: Make sure to set the API key header to "Authorization" in your DHL settings. DHL will use this header to authenticate each tracking update it sends to the platform.

Configuration Status

After saving, the settings page displays a status summary showing:

Status: Whether the configuration is enabled or disabled
Configuration ID: Your DHL configuration identifier
Webhook URL: The registered webhook endpoint
Max Requests/Second: Rate limit (100 per second)
Last Updated: When the configuration was last changed

Disabling DHL Pusher

If you need to temporarily stop receiving live tracking updates:

Go to the DHL Pusher settings page
Click the "Disable Pusher" button
Your configuration is preserved but tracking updates will stop
You can re-enable at any time without reconfiguring

Regenerating the Auth Key

If you need to regenerate your webhook authentication key (for example, if it may have been compromised):

Click "Generate auth key" on the DHL Pusher settings page
Copy the new key and update it in your DHL Track and Trace Pusher settings
The old key will no longer be accepted