Event

Endpoints relating to Event objects

List all webhook events

Returns a list of all events delivered to any webhook registered by this client

Request
query Parameters
f.type
string

Filter by the type of the event

Example: f.type=/shipment_leg#departed
f.occurred_at.gte
string

Filter by events which occurred on or after this datetime

Example: f.occurred_at.gte=2020-01-10T20:00:00.000Z
f.occurred_at.lte
string

Filter by events which occurred on or before this datetime

Example: f.occurred_at.lte=2020-01-10T20:00:00.000Z
f.data.shipment.id
integer

Get all events which involved the shipment with this ID. Only event payloads that embed a top-level 'shipment' object support this filter: shipment events (types starting with /shipment#, /shipment_leg#, /ocean/shipment_container# or /ocean/shipment_container_leg#) and freight milestones. Invoice (/invoice#), document (/document#), order-management (/purchase_order#* and related types) and async-API events reference shipments only through a 'resource' link, so this filter never matches them. To list invoice events, filter by event type and time range instead, e.g. 'f.type=/invoice#invoice_shared&f.occurred_at.gte=2026-01-01T00:00:00.000Z'

f.data.resource._object
string

Get all events which involved a resource of this type. The key for this filter will be the '_object' value for your target resource. Note: this filter can be combined with 'f.data.shipment.id' only for event types whose payload embeds a top-level shipment object (shipment-family events). For /invoice, /document and order-management resources the payload has no inline shipment, so combining the two filters always returns an empty result.

Enum: "/document" "/invoice" "/ocean/shipment_container" "/ocean/shipment_container_leg" "/shipment" "/shipment_leg"
Example: f.data.resource._object=/invoice
Responses
200

Success

Response Schema: application/json
_object
string
self
string
version
integer
object
_object
string
prev
string or null
next
string or null
Array of objects (WebhookEvent)
400

error

get/events
Response samples
application/json
{
  • "_object": "/api/response",
  • "version": 2,
  • "data": {
    • "_object": "/api/collections/paginated",
    • "prev": null,
    • "next": null,
    • "data": [
      • {
        }
      ]
    }
}

Retrieve a single webhook event

Returns the webhook event with ID ":id"

Request
path Parameters
id
required
integer

The unique id for the event object to be retrieved

Responses
200

Success

Response Schema: application/json
_object
string
self
string
version
integer
object (WebhookEvent)
_object
string

Type of the object

id
integer
version
integer
created_at
string
occurred_at
string
type
string
object (ShipmentEventData)
400

error

get/events/{id}
Response samples
application/json
{
  • "_object": "/api/response",
  • "version": 2,
  • "data": {
    • "_object": "/event",
    • "id": 354987,
    • "version": 2,
    • "created_at": "2019-04-16T18:05:10.964Z",
    • "occurred_at": "2019-04-16T18:05:10.964Z",
    • "type": "/shipment_leg#departed",
    • "data": {
      • "_object": "/shipment_event_data",
      • "resource": {
        },
      • "shipment": {
        },
      • "location": {
        },
      • "containers": [
        ],
      • "exception": {
        }
      }
    }
}

Import Filing FiledWebhook

Produced as soon as an import declaration is filed with customs.

The event type is /import_filing#filed. Its data contains the entry number, customs zone, and a shipment reference with its ID and API link. The entry number is always present and never null.

Currently available for US import filings. The payload supports import filings in other customs zones.

Request
Request Body schema: application/json
required
_object
string

Type of the object, always /event here

id
integer

A unique ID of a webhook notification

version
integer
created_at
string
occurred_at
string
type
required
string

Webhook event type, containing information about the operation it refers to

Value: "/import_filing#filed"
required
object (ImportFiling)
_object
required
string
Value: "/import_filing"
entry_number
required
string

The entry number of the filed import declaration. Always present and never null.

customs_zone
required
string

The customs zone where the import declaration was filed, such as US, EU, or CA. Currently only US filings are published.

required
object

A reference to the shipment, including its ID and API link.

Responses
200

Return a 200 response to indicate that the webhook has been received successfully.

Request samples
application/json
{
  • "_object": "/event",
  • "id": 987654,
  • "type": "/import_filing#filed",
  • "created_at": "2026-10-14T10:00:01.000Z",
  • "occurred_at": "2026-10-14T10:00:00.000Z",
  • "version": 3,
  • "data": {
    • "_object": "/import_filing",
    • "entry_number": "CHQ-0136514-9",
    • "customs_zone": "US",
    • "shipment": {}
    }
}