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 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, also known as the native delivery schedule. This will result in an orderEvent in the POST request body.

  • Only on delivery line per order line, also known as the simple delivery schedule. This will result in a simpleOrderEvent in the POST request body.

See the API manual to read about the native versus the simple delivery schedule.

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:

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:

Method, URL and credentials

Finally, configure the webhook method, URL and credentials:

  • Select GET or POST as HTTP method.

  • Enter your webhook URL:

    • The URL must start with https://

    • The URL must contain the {orderId} or {shipmentId} variabl in case of GET method.

  • Enter either Basic authentication username and password or a static Bearer token.

  • Save the settings

You can test webhook triggers using webhook.site

Use a bogus username and password.

Last updated