Webhook Overview

A webhook is how your application receives updates from Tracksuite as they happen. When a shipment status changes, Tracksuite sends the data to the webhook URL you configured. You choose which shipment statuses to receive.

How to configure Webhook

1. Open Settings → API & Webhooks in the Tracksuite Portal.
2. Enter the endpoint URL and select the events you want. Leave every box unchecked to receive all events.
3. Save, and copy the signing secret on the same page. Nothing is sent until both the URL and the secret are set.

Event names, the request, and the signature are in Webhook Specifications.

Webhook Security

Both HTTP and HTTPS URLs are supported, so you can use an SSL-enabled URL for stronger security. Your endpoint can also be reached by others. To stop them from submitting arbitrary data to your webhook, always verify the request with the webhook secret.

Webhooks Retries

Tracksuite sends each update with POST. Your server must return 2xx within 5 seconds. If it does not, the same event is sent again. eventId stays the same, so use it to skip a duplicate.

A retry waits at least 1 minute. The wait then grows, and does not exceed 12 hours. The exact wait is chosen at random inside that range. One event is sent at most 12 times.