Create Tracking Webhook

Set up the tracking webhook connection

To set up the webhook please log onto the system and in the Main Menu navigate to API > Tracking > Tracking Webhook.

Configuration steps:

1. Add the Endpoint URL you want us to send the tracking updates to. Use an HTTPS endpoint to ensure a secure way of sending the data.
2. Define the authentication method that your system will use to authenticate the tracking webhook API calls
   1. OAuth2 authentication
      1. Token URL - this is an endpoint we connect to, to get the security token
      2. Client ID, and Secret to identify and authenticate the Intersoft payload
   2. Basic authentication
      1. Endpoint URL - this is an endpoint we connect to, to identify
      2. Username and password to identify and authenticate the Intersoft payload
3. Test the webhook connection to ensure the setup is correct.

Only when a successful response is returned will the webhook be activated. If the connection test fails, please check that the details entered are correct.

Successful connection response:

Failed connection response (example):

If the connection is successful, a test tracking payload is sent to the webhook. Please see the example of the test payload below:

4. Select from the dropdown to receive either Milestones or Full Tracking Events

Milestones are key events that occur in the delivery journey, such as the shipment being received by the carrier, going out for delivery, being delivered successfully etc.

You can choose whether you want to receive tracking milestones OR full tracking events. You are able to choose only one option.

• If you select to receive milestones only, we will only push tracking, when a new milestone is triggered.
• If you select to receive full tracking events, we will push tracking every time we receive a new tracking event from the carrier, whether that tracking event triggers a new milestone or not.

A list of milestones and full tracking events can be found here.

5. Change the 'Active' toggle into the active stage if you are ready to activate the tracking webhook.

🚧

IMPORTANT

The webhook will only work if it is set to 'Active'. Please note that any changes to the webhook configuration will deactivate it, so ensure the toggle is set to 'Active' once you are happy with the changes.

5. Save the changes to confirm the setup is completed.