Vessel Schedule Event Subscriptions API
- April Hart
- Chris Boxall
Use Vessel Schedule Event subscriptions when you want PortConnect to send you an http (“webhook”) callback when any vessel schedule event occurs. Vessel Schedule Event Subscriptions work in a more simplified way to compared to the Container Visit Event Subscription end point.
- Get Single Vessel Schedule Subscription — GET /v1/subscriptions-vessel-schedule/{subscriptionId}
- Get All Vessel Schedule Subscriptions - V1 — GET /v1/subscriptions-vessel-schedule
- Create Vessel Schedule Subscription — POST /v1/subscriptions-vessel-schedule
- Delete Vessel Schedule Subscription — DELETE /v1/subscriptions-vessel-schedule/{subscriptionId}
- Vessel Schedule Event Types — The supported events types for the Vessel Schedule Subscription:
- Webhook Callback Payload - Vessel Schedule — The data sent to the given urls or emails
Creating a Subscription
To receive callbacks for particular vessel schedule events, you can create a subscription by posting a request to the subscriptions endpoint.
Callbacks can be sent as emails to multiple email addresses or as HTTP requests.
When Vessel Schedule Events are sent
When PortConnect receive an update from the partner port, we will only generate another event if the previous raised event Arrival Dttm or Departure Dttm is different to the new file.
6 hour time limit for Notifications: E.g. It is currently 11.59am, Vessel ETD is set to 6pm so a Notification will be sent. If the time was 12.30pm a Notification would not be sent.
Related content
© PortConnect 2023