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
  }
]

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.

PortConnect Help

Webhook Callback Payload - Vessel Schedule

Example

Example Callback Email