Webhook Connector

Tradecloud triggers a webhook to notify the buyer or supplier the order or shipment is new or has been updated.

Using the webhook

Tradecloud sends a webhook trigger to your webhook service

When an order or shipment is new or has been changed at Tradecloud, we will trigger your webhook.
You can either choose between the POST or GET webhook:
  • POST will contain the order event, order documents event or shipment event in a JSON or tXML body.
  • GET will contain the order ID or shipment ID as path or query parameter.
See the API manual to read about pro's and cons of either choice.

Using the POST webhook

In case of a POST webhook you can use the order data of the event inside the request body.

Your webhook service downloads the actual document from Tradecloud

If you are receiving order documents events, the POST request body contains a document objectId. You must download the document as the document content is not embedded in the event itself.

Using the GET webhook

In case of a GET webhook, the triggered webhook URL contains an order ID or shipment ID parameter, for example:
GET https://yourcompany.com/any/order/path/:orderId
GET https://yourcompany.com/any/shipment/path/:shipmentId

Your webhook service fetches the actual order or shipment from Tradecloud

When using the GET webhook, you must fetch the actual order or shipment from Tradecloud using the order ID or shipment ID:
GET https://api.accp.tradecloud1.com/order/:orderId
GET https://api.accp.tradecloud1.com/shipment/:shipmentId

Next: setting up the webhook