WebhookPayload

All events are sent via webhook. You define a single HTTP endpoint that can receive POST messages with a JSON body, and we send events to that endpoint in real time. Some examples are below:

importers_activated	An Importer has been activated for use
shipments_billMatch	An ISF has received a bill match with Customs
shipments_inquireDoc	An additional document is required for Customs entry
shipments_customsHold	A Customs hold has occurred on a Shipment
shipments_customsRelease	A Shipment has been released by Customs
invoices_invoiced	A new Invoice has been generated

A single payload can contain multiple events, and each event includes a JSON body field specific to that event type. A full list of event types can be found here.

You will choose 1 test endpoint and 1 production endpoint. We will send your test/production API key in the x-api-key header which you can use to verify the sender.

During testing, you can use the triggerEvent mutation to send webhook events to the test endpoint. We have found ngrok to be a great way to setup a test endpoint that tunnels to your localhost server.

If the webhook fails to send, we will retry 1 second later, and 2 seconds after that. If none of these 3 attempts work, we will send an email with the event and error to an inbox you specify.