The TradeLens platform provides several types of event subscriptions, which you can access according to the type of organization you belong to.
In this article
Types of subscription
There are five types of subscription available on the TradeLens platform:
- Organization
- Country
- Port
- Province
- Terminal
You will be able to access the above subscriptions based on your organization. For example, you can set up an organization subscription if you’re a member of that organization. You can access a port subscription if you work for a port. And anyone working for an authority or customs organization will be able to create a country subscription for the associated country.
How to subscribe to TradeLens data
From the home page, click Account on the left-hand menu. Then click Subscriptions.
Click the Create Subscriptions button to the right and middle of the page. You’ll see different options according to the organization you work for. In this example, we’ll choose Organization.
The page will now display four boxes for you to fill in: three are optional and one is required to create your subscription.
If you want access to a port, province, country or terminal subscription, you must use the port (or ports for a province), country or terminal that your organization was associated with during the provisioning process.
Name
Enter your first and last name if desired (optional).
Shared Secret
Enter a password if desired (optional). Ideally, it should not be easy to guess and longer than 30 characters.
URL
Enter the URL (required). This should start with https:// – for our simplified example, we are using a test webhook. In a real scenario, you must have your own code ready to receive data at your webhook URL.
A webhook is a URL and type of API (application programming interface) driven by events not requests. They’re a simple solution to enable real-time notifications and updates without having to develop a larger, more complex API.
Org Event Types
Click the Org Event Types box (optional). A pop-up will appear with five expandable menus detailing the different event types:
- Document
- Transport
- Consignment
- Shipment
- Generic
If you’d like to pick and choose which events to subscribe to, open the relevant menus and tick the boxes of the events you want.
If you’d like to subscribe to all events, skip over the Org Event Types box and click Create Subscription.
