Create Vessel Schedule Subscription
- April Hickson
Endpoint
POST https://api.portconnect.io/v1/subscriptions-vessel-scheduleRequest Body
Name | Type | Description |
|---|---|---|
subscriptionData | SubscriptionVesselScheduleNewV1 | Defines the events being subscribed to. |
Response Body
Name | Type | Description |
|---|---|---|
SubscriptionVesselScheduleV1 | SubscriptionVesselScheduleV1 | Created vessel schedule event subscription |
Example Request
For example, the following request will result in a webhook callback when any vessel related events occur at the Port of Tauranga.
POST /v1/subscriptions-vessel-schedule{
"webhookURI": "https://api.yourcompany.co.nz/webhooks/", // Optional if emailAddressList is present
"webhookToken": "yoursecret", // Optional if emailAddressList is present
"emailAddressList": ["me@test.com"] // Optional if webhookURI and webhookToken are present
"portCode": "NZTRG",
"wharfType": "Terminal"
}Specific Vessels
Optionally, specific vessels can be included in the payload if desired. Vessels are identified by the port vessel reference or by the Lloyd/IMO number of the vessel.
For the eventTypeCodes you can create a subscription for
specific event e.g. VesselCancelled
multiple
“ALL”
Single EventTypeCode
Multiple EventTypeCodes
All EventTypeCodes
Wharf Type
Finally, you can specify just one port and get callbacks without filtering by wharftype
Just like container visit subscriptions there is the option to have the callbacks as emails as shown below.
Example Response
© PortConnect 2023