Webhook Connector

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

Using the webhook

1. Tradecloud sends a webhook trigger to your webhook service

When an order (response) is new or has been changed at Tradecloud, we will trigger your webhook service.

The triggered webhook URL contains an orderId parameter, for example:

GET https://company.com/any/path/:orderId

2. Your webhook service fetches the actual order from Tradecloud

Using the orderId, you may fetch the actual order from Tradecloud, for example:

GET https://test.tradecloud.nl/api/v1/purchaseOrder/:orderId

Setting up your webhook service

To receive a webhook trigger you will need:

  • a simple web service reachable from the internet, which listens to some URL

  • the web service should use SSL and you need a SSL certificate

  • the web service should support basic authentication

  • the HTTP method should be GET

  • the URL should contain a parameter orderId

get
Webhook method

https://company.com/any/path/:orderId
The webhook method is used to notify the buyer/supplier the order (response) is new or has been updated.
Request
Response
Path Parameters
orderId
required
string
Tradecloud order identifier
Body Parameters
body
optional
string
The request will contain a body, but this is in beta and the json structure will change.
200: OK

You can test the security level of your SSL certificate at SSL Labs

Configure your webhook in Tradecloud1

As a company admin you may configure a webhook in your company profile on the Tradecloud1 platform:

  • Type: select Webhook

  • HTTP method: select GET (POST is not yet supported)

  • URL: enter your webhook URL. https and {orderId} are required.

  • Username: enter the user name as configured in your webhook service

  • Password: enter the password as configured in your webhook service