TradeLens provides the JSON schema to consume the payload sent to your webhook from the subscription service.
In this article
- Event Subscription API
- API documentation
- Subscription data
Event Subscription API
You can find and edit the JSON schema in the Event Subscription API section of Swagger.
If you’ve been onboarded onto a stack other than ‘platform,’ replace platform in the above url with your stack name. For example, Maersk: https://maersk.tradelens.com/documentation/swagger/
The API is just for documentation purposes for you to review. You can also open the Model in the Responses section of the Swagger to see the superset of possible fields in events posted to configured subscriptions. Descriptions are provided for each field.
Subscription data comprises data from the event payload as provided by the publisher, plus additional data from TradeLens to assist subscribers.