Skip to main content

Specification

Ship24 will be using an endpoint that needs to be created in your system and accessible by what we call your "Webhook URL.

Your endpoint needs to implement two HTTP methods:

  • HEAD https://your-server.com/your-endpoint

Ship24 will be probing this endpoint using a HEAD request to make sure your server is ready to receive webhooks. A HEAD request and response don't contain any body, you just need to return a 200 OK HTTP code to our HEAD requests.

caution

You will not be able to set up and save your Webhook URL in our dashboard if your endpoint doesn't return a 200 OK to our HEAD requests. If your platform doesn't allow you to do so or you are having problems setting up the webhook address, contact us!

  • POST https://your-server.com/your-endpoint

Ship24 will be pushing tracking updates to your endpoint using POST. The format of the request is detailed in the API Reference

The response body that you choose to return is not impacting as long you as the endpoint answer an HTTP status code in the 2xx range. Nevertheless, we recommend returning useful information that can be helpful if any issue arises while keeping the response body size reasonable to reduce your outgoing traffic costs.