Configure the webhook

Select one or more webhooks

A company admin can configure one or more webhooks in your company settings on the Tradecloud One platform:

Select My company in the menu below your avatar.
The Settings tab in the Company menu should be selected.
Configure one or more Webhook Integrations below.

Orders Webhook Integration

Enable the Order Webhook Integration if you want to receive a webhook trigger when an order has been issued or changed:

A default set of order events will be enabled. The actual set you want to select wil be dependent on the capabilities of your integration and ERP system and your order process requirements. You can find a list of events here:

Order Events

Order Delivery Schedule

You can configure the way the delivery schedule is included in the body of a webhook POST request. You can choose between:

Multiple delivery lines per order line. This will result in an orderEvent in the POST request body.
Only one delivery line per order line. This will result in a singleDeliveryOrderEvent in the POST request body.

See the API manual to read about the delivery schedule versus the single delivery per order line.

Order Documents Webhook Integration

Enable the Order Documents Webhook Integration if you want to receive a webhook trigger when an order document has been attached:

You may choose whether you want to receive events for documents added by the buyer of an order, the suppplier, or both. You can find a list of events here:

Order Documents Events

Shipments Webhook Integration

Enable the Shipment Webhook Integration if you want to receive a webhook trigger when a shipment has been issued or changed:

A default set of shipments events will be enabled. The actual set you want to select wil be dependent on the capabilities of your integration and ERP system and your shipment process requirements. You can find a list of events here:

Shipment Events

Method and URL

Configure the webhook method and endpoint URL:

Select GET or POST as HTTP method.
Enter your webhook endpoint URL:
- The URL must start with https://
- The URL must contain the {orderId} or {shipmentId} variable in case of GET method.

Credentials

Finally, configure the credentials. Choose either Basic authentication, Bearer token or OAuth.

Basic authentication

Tradecloud supports Basic authentication, where the client sends a HTTPS request with the Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.

Published as RFC 7617 "The 'Basic' HTTP Authentication Scheme"

Fill in username and password, as provided by your webhook configuration, and save the settings.

Bearer token

Tradecloud supports Bearer authentication, where the client sends a HTTPS request with the Authorization header that contains word Bearer followed by a space and the static token.

Published as RFC 6750 "The OAuth 2.0 Authorization Framework: Bearer Token Usage"

Fill in the token, as provided by your webhook configuration, and save the settings.

OAuth

Tradecloud supports the Oauth 2.0 Client Credentials Grant, where the client sends a HTTPS form request with:

grant_type with value client_credentials
client_id, client_secret and scope

Published as the RFC 6749 "Oauth 2.0 Client Credentials Grant"

Fill in the fields:

authentication URL: the OAuth 2.0 token endpoint including your Directory (tenant) ID, for example https://login.microsoftonline.com/<Tenant ID>/oauth2/v2.0/token
client ID: the Application (client) ID of your webhook client app as configured in Ms Azure AD
client Secret: the Client Secret Value of your webhook client app as configured in Ms Azure AD
scope: the scope granted to the webhook client app, for example containing the webhook endpoint https://<webhook endpoint>/.default.

Testing

You can test webhook triggers using webhook.site

Use a bogus username and password when testing against webhook site.

PreviousSetting up the webhook NextOrder Events

Last updated 1 month ago