Skip to main content

Exceptions API

Receive OpenTrack exception alerts via API webhooks to automate operational workflows.

Updated today

The Exceptions API Add-on allows external systems to receive OpenTrack’s exception detection events in real time.

When OpenTrack detects a significant change affecting a container’s journey, a webhook event is automatically sent to the customer’s system with details about the container, the detected exception, and the operational impact.

This allows organizations to integrate OpenTrack’s exception monitoring directly into their own systems, workflows, or customer-facing tools.


What Are Exceptions?

Exceptions in OpenTrack represent important disruptions or operational risks that may impact a container’s journey.

OpenTrack can detect events such as:

  • Rolled cargo events

  • Containers approaching demurrage risk

  • High street dwell time

  • High rail dwell time

  • Split cargo events

  • Active holds

  • Containers without rail sightings for extended periods

These events are automatically detected within the OpenTrack platform and surfaced in operational dashboards.

The Exceptions API makes these signals available to external systems so teams can automate alerts, workflows, and operational responses.


How the Exceptions API Works

The Exceptions API uses webhook notifications to deliver exception events when they occur.

The process works as follows:

  1. A customer registers a webhook endpoint in their system

  2. OpenTrack detects an exception affecting a tracked container

  3. A webhook event (container.exceptions.updated) is sent to the registered endpoint

  4. The receiving system processes the event and can trigger alerts, workflows, or updates

This allows exception events to be incorporated into internal systems without requiring manual monitoring.


Supported Exception Types in the API

The Exceptions API currently supports the following exception event:

  • Rolled Cargo

This event occurs when a container is reassigned to a different vessel.

Two possible status values may be returned:

  • Rolled – The container was moved to a later vessel and the ETA was delayed

  • Advanced – The container was moved to an earlier vessel and the ETA improved

Additional exception types detected by OpenTrack, including demurrage risk, dwell alerts, and operational holds, are planned for future API support.


Example Webhook Event

Below is an example webhook event generated when a rolled cargo exception is detected.

{
"event": "container.exceptions.updated",
"data": {
"containerId": "MSCU1234567",
"masterBillNumber": "MEDU123456789",
"exceptionName": "rolledCargo",
"exceptionStatus": "Rolled",
"originPort": { ... },
"destinationPort": { ... },
"previousVessel": { "name": "ORIGINAL VESSEL" },
"currentVessel": { "name": "NEW VESSEL", "imo": "1234", "mmsi": "1234" },
"previousEta": "2025-12-11T16:00:00.000Z",
"currentEta": "2025-12-14T16:00:00.000Z"
}
}

This payload contains the key shipment details needed for external systems to understand the operational impact of the event.


Operational Use Cases

Organizations use the Exceptions API to integrate disruption signals directly into their operational workflows.

Common use cases include:

  • Automated alerting

    Trigger internal alerts when vessel changes or disruptions occur.

  • Operational workflow automation

    Automatically initiate rebooking workflows or operational reviews when exceptions are detected.

  • Customer-facing dashboards

    Display exception data within customer portals or external tracking platforms.

  • AI-driven decision systems

    Provide real-time disruption signals to automation systems or AI agents managing operational responses.


Availability

The Exceptions API is available as an add-on feature within OpenTrack.

If you would like to enable the Exceptions API or learn more about integrating it with your systems, contact: support@opentrack.co

Did this answer your question?