...
Overview
Webhooks in the Veson IMOS Platform are a tool for generating real-time feedback and providing suggested changes to users as they work in the Voyage Estimator. Like Tasks & Alerts, messages are generated and displayed in the notifications panel based on logical rules applied to the current data. Unlike standard Tasks & Alerts, webhooks allow you to write whatever logic you choose in a programming language of your choice, as long as you can host it as a web endpoint. The response payload may also include suggested changes that can be automatically applied to the estimate itself.
...
The request includes the fields configured in the webhook setup, as per the VIP Veson IMOS Platform Reporting schema, serialized as JSON.
...
The expected response is a JSON blob consisting of an array of alert objects. An alert object can have the following fields:
Field | Type | Description |
---|---|---|
| string | The message that appears to the user. (Required) |
| One of: | Determines the icon that appears with the alert. (Optional) |
| string (GUID) | An identifier for the alert. If provided, should be unique in the context of a single response. Can be used to indicate that a given alert is the “same” as one provided in a previous response. (Optional) |
| object | A mutation that can be applied by the user, in the same format used in the imos/applyUpdateEstimate GraphQL API (Optional) |
| object | Customized field labels and values that can be displayed in the body of the card (Optional) |
| string | Field label displayed in the body of the card’s Display Fields section (Optional) |
| string | Matching value displayed with the label in the body of the card’s Display Fields section (Optional) |
| string | A link specified by the user, presumably leading to the source of the webhook data. (Optional) |
Expand | ||
---|---|---|
| ||
|
Expand | ||
---|---|---|
| ||
This is the schema as of October 2022. The most updated schema can always be found at: https://emea.veslink.com/schema/messages/UpdateEstimate
|
Info |
---|
If you want “applied” mutations to appear as applied to the end user, include a consistent GUID (globally unique identifier) with the alert object. If no GUID or a new GUID is returned, the mutation will be interpreted as new on the front-end and displayed as such to the end users. Regardless, reloading an estimate will reload all webhook alerts and their statuses. This is planned for future improvement. |
...