📘

Push vs Pull API

Not sure which method to use for tracking your containers? Check out our guide on the differences between synchronous and asynchronous tracking: Synchronous and Asynchronous Tracking.

If you’re considering using a Push container tracking API, here’s what you need to do:

• Set up how you want to receive data.
• Push shipment details to our monitoring system.
• Receive initial tracking data for the shipment.
• Get updates whenever we have new data for that shipment.
• [Optional] Receive alerts if any of the shipments you’ve pushed cannot be tracked.

Here’s a quick guide to help you through this process:

Set up your endpoint and push your first shipments

Follow our straightforward tutorial to configure your first container tracking webhook. Get started

Recommended events for shipment tracking

• To receive initial tracking data for a shipment, subscribe to the event: _shipment.added.to.endpoint_.

• To receive updates whenever new data is available, subscribe to: _shipment.any.change_.

• To get alerts when a shipment you’ve pushed cannot be tracked, subscribe to: _shipment.in.error_ and _shipment.auto.removed_.

Track Specific Events for Targeted Notifications

Using the Webhook API as a PUSH API does not limit you from needing more targetted notifications. You can subscribe to more granular events, which will help you quickly identify what has changed by examining the specific event details.

For example, subscribing to _date.changed.vessel.arrival.at.final.pod_ will notify you whenever there is a change in the estimated time of arrival at POD, while the _shipment.any.change_ event will keep you informed of all other updates, ensuring you never miss important data.

📘

Duplicate data

If you subscribe to both _shipment.any.change_ and targeted events, you may receive multiple webhooks for the same data update.