Set up tracking webhook connection
Tracking webhook is a mechanism that enables real-time communication between shipping platforms and the systems or applications of shippers via API.
The primary purpose of a tracking webhook is to automate the flow of information regarding the status of shipments . Instead of relying on periodic updates (where one system constantly checks another for updates)—webhooks enable instantaneous updates.
In SAPIENT, you can set up your tracking webhook connection to enhance the overall efficiency of logistics by ensuring that all stakeholders have immediate and accurate information on their shipments.
To set up the tracking webhook connection in SAPIENT, follow the instructions as explained in the following procedure.
- On the SAPIENT Home page, in the left navigation panel, select API > Webhooks. In the page that opens, the Tracking Webhook tab is opened by default.
Accessing tracking webhook
- In the WEBHOOK DETAILS block of the Tracking Webhook tab, enter the necessary information as described in the following table.
Tip
In the following table, the mandatory fields are marked with an asterisk (*).
| Element | Basic authentication | OAuth2 authentication |
|---|---|---|
| Authentication type* | From the dropdown menu, if applicable, select the Basic authentication type. Basic is a simple authentication type built into the HTTP protocol. It involves sending the user's credentials (username and password) in an encoded format (Base64) within an HTTP header. | From the dropdown menu, if applicable, select the OAuth2 authentication type. oAuth2 is a specific protocol used for authorisation that allows third-party applications to access the user's data without exposing their credentials. It also involves exchanging credentials for an authorisation token, which is then used to authenticate in other API calls. |
| Endpoint URL* | Enter your endpoint URL. This is the URL that we use to connect for identification purposes. | Enter your endpoint URL. This is the URL that we use to connect for identification purposes. |
| Username* | Enter your username to identify and authenticate the INTERSOFT payload. | ❌ Not applicable |
| Password* | Enter the password for the username you entered to identify and authenticate the INTERSOFT payload. | ❌ Not applicable |
| Token URL* | ❌ Not applicable | Enter your token URL. This is an endpoint we use to connect and get the security token. |
| Client ID* | ❌ Not applicable | Enter your client ID to identify and authenticate the INTERSOFT payload. |
| Secret* | ❌ Not applicable | Enter your secret to identify and authenticate the INTERSOFT payload |
- After entering all the necessary details, select
to check if the setup is configured correctly. Once the test has been completed, and the setup configuration is correct, the webhook is activated and the following success response is displayed:
Success response
Following the success response, a test tracking payload is sent to the webhook as follows:
tracking payload response example
If for some reason, the connectivity test fails, the following message is displayed:
Failed connection response
Important
The connectivity test fails when SAPIENT is unable to call the configured endpoint with the credentials provided by the customer. To avoid that, it is recommended for the customers to check the credentials and endpoint URL for correctness—update it, if necessary, and try again. If the credentials and URL are correct and the test still fails, then the customers need to check whether the endpoint is working correctly on their side.
- Now, from the Select to receive either Milestones or Full Tracking Events dropdown, select one of the following options:
- Milestones: to receive tracking milestones only.
- Full Tracking Events: to receive all tracking events throughout the shipping journey.
Tip
A list of milestones and full tracking events can be found in the Tracking events and milestones section.
- After, turn on the Active toggle if you wany to activate the tracking webhook.
Activating tracking webhook
Important
The webhook only works if it is in the Active state. Any changes made to the webhook configuration deactivates it. Therefore, make sure the toggle is set to Active whenever the configuration is updated.
- Select
to confirm the setup completion.
Updated 26 days ago