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

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

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)
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)
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": {
        }
      }
    }
}