This article will provide details for each of the types of Public API webhooks available for consumption. Each webhook has a specific purpose and type of data being sent to help minimize API calls and provide valuable data for external integrations.
Service Overview
These are the primary webhooks supported via Tai.
| Service Name | Short Description |
| ShipmentCreateUrl | Sends Shipment Details data on shipment creation. |
| ShipmentDetailUpdateUrl | Sends Shipment Details data on shipment updates (this includes shipment information, address, commodity, etc). |
| ShipmentStatusUpdateURL |
Sends Shipment Details data on shipment status updates (this includes status, shipment dates). Note: Alerts do NOT trigger webhooks |
| ShipmentLocationUpdateUrl | Sends simplified shipment data based on location updates, but will only trigger if the last update was more than 15 minutes ago. |
| ShipmentLocationUpdateExtendedUrl | Sends detailed shipment data based on location updates, triggering only if the last update was more than 15 minutes ago. |
| BillCreateUrl | Sends Bill Data with Approve Bill workflow |
| InvoiceCreateUrl | Sends Invoice Data when the Invoice Create is completed |
| InvoiceCreateWithShipmentUrl | Sends Invoice and Shipment Data when the Invoice Create is completed |
| LSPCarrierCreateUrl | Sends carrier details data on carrier creation. |
| LSPCarrierUpdateUrl | Sends carrier details data on carrier updates. |
| CustomerCreateUrl | Sends customer details data on customer creation. |
| CustomerUpdateUrl | Sends customer details data on customer updates. |
Webhook Integration Setup
This requires an integration to have been set up in the TMS before webhooks can be sent out. Here's a link to the
Webhook Integration Setup Documentation.
Webhook Documentation URL
Sample responses when webhooks trigger are as shown in the documentation listed below.
Production URL: http://[your TMS Url]/PublicApi/swagger/index#/WebHooks
Implementation
This implementation information is intended to provide a high-level guide to implement this service. There are sample JSON responses that can be accessed with the Production URL documentation. These are to trigger data to be automatically sent anytime the trigger gets activated.
Workflow
ShipmentCreateUrl is used to trigger anytime a shipment is created. This is helpful for storing data for Shipments that may have been booked or created by your Customers, or Internal Staff. Ideally this would be the first step to get the Shipment information sent over.
ShipmentDetailUpdateUrl is used to trigger updated data for any shipments that may have been updated. The information is presented in the same format as the ShipmentCreateUrl. These work side by side so you get the most updated information regarding any shipments within the TMS.
ShipmentStatusUpdateUrl is used to trigger status update data for any shipments that has had a change in status. This includes shipment status and shipment dates associated to stops.
ShipmentLocationUpdateUrl is used to trigger location update data for any shipments that has had a new location added. This data will only resturn the most recent location data.
BillCreateUrl is used to trigger Bill information that has been approved to any Webhook URL of your choosing. This will allow you to transmit any AP related invoice that have been created.
InvoiceCreateUrl is used to trigger Invoice information that has been created to any Webhook URL of your choosing. This will allow you to transmit any AR related invoice that have been created.
InvoiceCreateWithShipmentUrl is used to trigger Invoice information along with current shipment data to any Webhook URL of your choosing. This will allow you to transmit any AR related invoice that has been created along with the current status and info regarding the shipment the invoice is related to.