SpeEDI Cargo Help Centre

TABLE OF CONTENTS

• Overview
• Deployment
• Documentation
• Testing
• Troubleshooting
  • SpeEDI is failing to send webhooks and showing a status code

Overview

If CCA notifications for goods release are being pushed to SpeEDI, you can additionally forward them to an endpoint of your choosing (such as your ERP) via the Webhook function.

More information on CCA notifications here, Goods Release notification handling for CCAs.

This is valuable for operations looking to automate data transfer to improve the efficiency of the goods release process, and possibly analyse and use the data elsewhere.

Deployment

This assumes you are already receiving CCA notifications, deployment of webhooks on the SpeEDI end is very easy.

Navigate to Settings > Webhooks and press Add.

Enter the endpoint URL, and the shared secret [recommended] if used and press Save.

You can run an Echo test to check these settings are correct and the endpoint is configured as intended.

As releases are received, they will then be queued and pushed to the endpoint according to the documentation.

The status of the push can be viewed in the Release Notifications table (Shipments > Options > Recent Release Notifications) with an option for resending releases.

Documentation

Documentation for what to expect at the endpoint is available on the attached PDF (with intent to add to the TradeWindow Developer portal).

Testing

Unfortunately there is no ability to test send a webhook with a payload, and must have working production data. This is a future feature request.

If you are having trouble processing the data received, some services such as RequestBin (no relation to TradeWindow) can generate an endpoint to receive and output raw post data to validate the data push is functional from SpeEDI.

Troubleshooting

SpeEDI is failing to send webhooks and showing a status code

This will be a failure on the endpoint, possible firewall or data expectation, and should be passed to the developer for the endpoint.