If you want information about your shipments, orders and drafts sent to your own system continuously, you can create webhooks to enable this.
To create a webhook, follow these two steps.
1. Create an endpoint
To receive messages from your webhooks, you need to have created an endpoint in your IT system to which the message can be sent from Shipmondo.
Some endpoint requirements need to be set up to receive the messages:
- The endpoint must use HTTPS and, therefore, a valid SSL/TLS certificate
- The endpoint must be able to receive JSON data
- The endpoint must be able to decrypt JWT data, which is encrypted with the HS256 algorithm, using a self-selected key
- The endpoint must be able to receive the message and reply with status code 200 within five seconds
- The requirements for the endpoint are described in more detail in this article.
NB! The endpoint can be used to receive messages from multiple webhooks, so it will not be necessary to create a new endpoint for each webhook.
2. Create a webhook in Shipmondo
Once an endpoint that can receive messages from the webhook has been created, you can create your webhook in Shipmondo.
To do this, go to Settings > Integration > Webhook and click on the Plus button (+) at the bottom right.
Fill in the fields as follows:
- Name: a name you can use to identify your webhook in your overview
- Endpoint: the URL of the endpoint you created in step 1
- Key: the key being used to encrypt and decrypt the webhook messages with JWT
- Resource: the resource you want the message to contain information about
- Action; the action you wish to trigger the webhook message
Check Active. Click Create.
Your webhook is now set up and you will start receiving messages at your endpoint when the selected action is taken.
Read more about how the messages from your webhooks are structured here.