Skip to content
Vellum

Ship arrived

Sent to the webhook address set on your account when a ship ties up at a berth. This example never sends it.

POST shipArrived Webhook

The API sends this request to an address you give it. Your app receives it and answers.

Header parameters

HMAC-SHA256 of the body with your webhook secret, in hex. Compare it before you trust the body.

Example 5d41402abc4b2a76b9719d911017c592

Payload

application/json
event* string

Value in ship.arrived

shipId* integer
berth* string
at* string

Format date-time

Responses

200 Received. Any other answer and the harbor tries again, up to five times.