Creating a Webhook Subscription

Create Webhook Subscription Dialog

1. Open the Webhooks module in the Alerts section.

2. Click Create Webhook Subscriptionin the top right corner.

3. Fill in the required fields (marked with *) for each step in the dialogue.

4. Click Create.

Types of Webhook Subscriptions

There can be created 3 types of webhooks in VMS; HTTP, Email and Websocket. HTTP and Email send notifications to the specified destination, while Websocket sends push notifications to users through VMS. Each with different options to fill out. Illustrations and further descriptions are shown below for which fields need to be filled to create a new Webhook Subscription.

Receiver Step

HTTP

Basic Authentication requires filling out a Username and Password for the endpoint. Request Token requires filling out an Access Token Request Url and an Access Token Request Body , with the other fields being optional.

Email

Websocket

Trigger Step

The Trigger is the condition that needs to be met for a notification to be sent to the Receiver. Either an existing Alert Script or an Expression can be selected. Below is an example Expression that needs the cargoQuantity of a Cargo to be changed, greater or equal to 1000, and that cargo's charterer to be equal to a specific user key. Limiting the number of notifications to be relevant and informative.

The Field can be selected with the Customize Columns modal, like in lists. Conditions can be customized in detail using grouping Add Group , to allow multiple combinations of AND /OR conditions. A simplified preview of the conditions are displayed at the bottom of the modal.

Payload Step

Template Message and Fields are optional. Template Message allows for a custom message where field values from the object can be inserted in the sent notification.

Fields limit what fields should be returned in the notification and can look like this {"fieldName1":"*","fieldName2":"*"}. Read more about how to specify Fields here.

General

All options are optional except User, which must be selected. This should in most cases be set to the user intended to receive the notification. As the permissions of that User decides the access to objects when the notification is sent. Failing notifications could be due to the User not having the right access. The description icon (i) can be hovered over to reveal additional information about their function.