Webhook Callback Payload - Vessel Schedule
When PortConnect detects an event that matches your subscription, it will send an HTTP POST to your specified end point. Event matching happens when new events are processed into the PortConnect system
For testing purposes, you may find it useful to create a webhook uri using Request Bin or similar. This allows you to easily view the webhook payload.
Example
Multiple events may be returned in a single payload, as in this example:
[
{
"SubscriptionEventId": 158843,
"SubscriptionId": 45,
"PartnerPortCode": "NZAKL",
"WharfType": "Terminal",
"WharfName": "FERGUSSON",
"VesselScheduleID": "6ac28a4f-55e4-4ffe-8e93-477b1959a2a6",
"VesselScheduleEventTypeCode": "VESSELDEPARTURE",
"VesselScheduleEventDatetime": "2024-05-08T23:27:00+12:00",
"VesselScheduleEventLocation": null,
"VesselName": "CAPITAINE TUPAIA",
"SubscriptionVesselScheduleId": 170,
"UserDefinedReference": "MyReference",
"VesselRef": "CUP9344",
"LloydNumber": 9410301,
"InboundVoyageNumber": "017S",
"OutboundVoyageNumber": "018N",
"SendCamelCase": false
"Agent": "Agent Name"
}
]Example Callback Email
Emails are sent with a table containing the most valuable data from the event, and an attachment containing the JSON payload of all the details.
Webhook token
Included as a header key of the callback is a value X-WebhookToken which includes the webhookToken value specified when creating the subscription. This is designed to help protect your webhook end point from unauthorised access.
headers
accept: application/json
content-length: 16577
content-type: application/json; charset=utf-8
host: eooh8n59jjcq4mz.m.pipedream.net
x-webhooktoken: 123-456-789-000
© PortConnect 2026