Webhooks
A webhook (also called a web callback or HTTP push API) is a way for Shiptify app to provide other applications with real-time information. Our webhook delivers data to other applications as it happens, meaning you get data immediately. Webhooks are sometimes referred to as "Reverse APIs".
If you would like Shiptify to POST event notifications, you need to provide us with a callback URL. Webhooks are at the account level so you can provide a unique URL for each account.
You can read more about the data that is posted for which event in the appropriate section below depending on whether you are considered as a shipper or a carrier (Ask your Shiptify account manager if you are wondering).
Authentication
Though you can use our securing webhooks signature (See set up my webhooks page) to verify the requests, you can also provide us with authentication method of your choice among the following types:
Parameter | Type |
---|---|
Api-Key | Headers |
Basic | Headers |
QS with any parameter | Headers |
No Auth. | Headers |
Payloads
When something has happened to your shipment, your URL will be called with application/json payload and with a standard set of data depending on the event and your account type.
Depending on your account type, shipper or carrier, there are 2 kinds of payload per account type: shipment or tracking.
For shipment payload type, there are several trigger events available. The shipment payload remains the same format for all events except for the event property.
Please refer carefully to the right Payload:
Account Type -> Payload Type -> Event Trigger
Event | Request | Payload | Event_type |
---|---|---|---|
Freight Unit created | POST | Freight Unit | freight_unit_create_shipment |
Freight Unit canceled | POST | Freight Unit | freight_unit_cancel_shipment |
Freight Unit content updated | POST | Freight Unit Update | freight_unit_update_shipment_contents |
Freight Unit tracking updated | POST | Freight Unit Tracking | freight_unit_update_tracking |
Shipment created | POST | Shipment | create_shipment |
Shipment updated | POST | Shipment | reactivate_shipment |
Shipment contents updated | POST | Shipment | update_shipment_contents |
Shipment dates updated | POST | Shipment | update_shipment_dates |
Shipment cancelled | POST | Shipment | cancel_shipment |
Visit created | POST | Visit | create_visit |
Visit updated | POST | Visit | update_visit |
Visit status updated | POST | Visit | inform_automatic_gate |
Visit Cancel | POST | Visit | cancel_visit |
Tracking point updated | POST | Tracking | update_tracking |
Last updated