Edit a Webhook

Authorizations

Authorization

string

header

required

Token YOUR_API_TOKEN

The APIs require authentication to be done using header-based API Key and Secret Authentication.

API key and secret are sent va the Authorization request header.

You send your API key and secret in the following way:

Authorization: Token YOUR_API_KEY

Path Parameters

string

required

Body

application/json

data

object

required

data.attributes

object

required

data.attributes.active

boolean

data.attributes.events

enum<string>[]

The list of events to enable for this endpoint.

Available options:

container.transport.vessel_arrived,

container.transport.vessel_discharged,

container.transport.vessel_loaded,

container.transport.vessel_departed,

container.transport.rail_departed,

container.transport.rail_arrived,

container.transport.rail_loaded,

container.transport.rail_unloaded,

container.transport.transshipment_arrived,

container.transport.transshipment_discharged,

container.transport.transshipment_loaded,

container.transport.transshipment_departed,

container.transport.feeder_arrived,

container.transport.feeder_discharged,

container.transport.feeder_loaded,

container.transport.feeder_departed,

container.transport.empty_out,

container.transport.full_in,

container.transport.full_out,

container.transport.empty_in,

container.transport.vessel_berthed,

shipment.estimated.arrival,

tracking_request.succeeded,

tracking_request.failed,

tracking_request.awaiting_manifest,

tracking_request.tracking_stopped,

container.created,

container.updated,

container.pod_terminal_changed,

container.transport.arrived_at_inland_destination,

container.transport.estimated.arrived_at_inland_destination,

container.pickup_lfd.changed

data.attributes.headers

object[]

Optional custom headers to pass with each webhook invocation

data.attributes.headers.name

string

The name of the header. (Please not this will be auto-capitalized)

data.attributes.headers.value

string

The value to pass for the header

data.attributes.url

string

The URL of the webhook endpoint.

data.type

enum<string>

required

Available options:

webhook

Response

200 - application/json

data

object

data.id

string

required

data.type

enum<string>

required

Available options:

webhook

data.attributes

object

data.attributes.active

boolean

default:

true

required

Whether the webhook will be delivered when events are triggered

data.attributes.events

enum<string>[]

required

The list of events to enabled for this endpoint

Available options:

container.transport.vessel_arrived,

container.transport.vessel_discharged,

container.transport.vessel_loaded,

container.transport.vessel_departed,

container.transport.rail_departed,

container.transport.rail_arrived,

container.transport.rail_loaded,

container.transport.rail_unloaded,

container.transport.transshipment_arrived,

container.transport.transshipment_discharged,

container.transport.transshipment_loaded,

container.transport.transshipment_departed,

container.transport.feeder_arrived,

container.transport.feeder_discharged,

container.transport.feeder_loaded,

container.transport.feeder_departed,

container.transport.empty_out,

container.transport.full_in,

container.transport.full_out,

container.transport.empty_in,

container.transport.vessel_berthed,

shipment.estimated.arrival,

tracking_request.succeeded,

tracking_request.failed,

tracking_request.awaiting_manifest,

tracking_request.tracking_stopped,

container.created,

container.updated,

container.pod_terminal_changed,

container.transport.arrived_at_inland_destination,

container.transport.estimated.arrived_at_inland_destination,

container.pickup_lfd.changed

data.attributes.secret

string

required

A random token that will sign all delivered webhooks

data.attributes.url

string

required

https end point

data.attributes.headers

object[] | null

data.attributes.headers.name

string

data.attributes.headers.value

string

Getting Started

In Depth Guides

Useful Info

Shipments

Tracking Requests

Tracking requests

Webhooks

Webhook Notifications

Containers

Shipping Lines

Metro Areas

Ports

Vessels

Terminals

Authorizations

Path Parameters

Body

Response