Knowledge Base
About DataloyRelease NotesAPI DocumentationJava VMS Documentation
Release 6.10
Release 6.10
  • Knowledge Base
  • Voyage Management System
    • VMS - Step by step guides
      • Vessels
        • Create Vessels
        • Find Vessels
        • Find Vessel Voyages and Port Calls
        • Find Vessel Speed and Consumption Data
          • Add Main Engine Speed
          • Add Bunker Type
        • Find Load and Discharge Rates
          • Manage Load And Discharge Rates
        • Find Vessel Internal Data
        • Find AIS and Weather Reports
        • AIS-subscription
        • View Vessel Route from Previous Port to Next Port
      • Voyages
        • Create Voyages
        • Find Voyages
        • Maintain Voyages
          • Schedule
          • Organisational data
          • Configure Voyage as a “Last TC Voyage”
          • Bunker Prices
          • Update Speed and Consumption
          • Change TCE and Voyage Result
          • Change Voyage Reference or Voyage Number
          • Edit Daily Hire
        • Delete Voyages
        • Voyage Map
        • Analysis
          • See Audit Log
        • Voyage Functions
          • Sensitivity Analysis
          • Intake Calculation
      • Cargoes
        • Create Cargoes
          • Create New Cargo
          • Create Cargo From Template
        • Maintain Cargoes
          • Cargo drawer
            • Main Details
            • Change cargo status
            • Sub-cargoes
            • Payment Terms
            • Various Cost/Revenue
            • Commissions
            • Comments
        • Find Cargoes
        • Allocate Cargo
        • Deleting Cargo
        • Create Commissions
        • Template Cargoes
        • Capacity Plan
        • Relet Cargoes
        • Transship and Preship Cargoes
        • Transfer Cargoes
      • Port Calls
        • Find Port Calls
        • Maintain Port Calls
          • Speed Order
        • Register Noon Reports
        • Register Arrivals
        • Register In Port Reports
        • Register Departures
        • View Overview on Port Calls
        • View Service Orders on Port Calls
        • View Bunker Orders on Port Calls
        • View Vessel Reports on Port Calls
        • View Port Log on Port Calls
          • Stoppages
      • Contracts of Affreightment
        • Create Contracts of Affreightment
        • Maintain Contracts of Affreightment
        • Find Contracts of Affreightment
        • Contract of Affreightment Lines
          • Find Contract of Affreightment Lines
          • Create Contract of Affreightment Lines
          • Maintain Contract of Affreightment Lines
          • Template Cargoes
            • Create Template Cargo
            • Maintain Template Cargo
            • Find Template Cargo
      • Broker Commissions
        • Create Commissions
        • Find Broker Commission
        • Maintain Broker Commission
      • Bunker Orders
        • Create Bunker Orders
          • Create from a port call
          • Create bunker order from scratch
        • Maintain Bunker Orders
        • Find Bunker Orders
        • Stem Bunker Orders
        • Register Delivery Against a Bunker Order
        • Cancel Bunker Order
        • Delete Bunker Order
      • Service Orders
        • Create Service Order
        • Maintain Service Order
        • Delete Service Order
      • Laytime Calculations
        • Create Laytime Calculation
        • Find Laytime Calculation
        • Maintain Laytime Calculation
          • Status
          • Panel Fields
          • Manage Cargo Ports
            • Cargo Port Fields
            • Statement Of Facts
            • Timesheet
      • Bills of Lading
        • Create Bills of Lading
        • Attachments
        • Edit Bills of Lading
        • Delete Bills of Lading
        • Print Bills of Lading
        • Print Sea Waybills
      • Offhire
        • Create Offhire
        • Find Offhire
        • Maintain Offhire
          • Delete Offhire
          • Copy Offhire
          • Status
          • Panel Fields
      • Vessel Reports
        • Find Vessel Reports
        • Create Vessel Reports
      • Voyage Analysis Dashboard
        • Log In
        • Viewing and Managing Deviated Voyages
          • Viewing and Managing Deviated Voyages
          • Viewing Post Voyage Analysis Detail
          • No Freight Received
      • Invoices
        • Invoices List
          • Invoice drawer
        • Pending Receivable List
        • Pending Payable List
        • Pending Hire Payable List
        • Assemble
        • Edit Document Line
      • Bunker Transactions
      • Accruals
        • Accruals
          • Batch Post Accruals
          • Generate Accruals
          • Find Accruals
          • Maintain Accruals
        • Bunker Stock Adjustments List
          • Batch Post Bunker Stock Adjustments
          • Bunker Stock Adjustment Drawer
        • Time Correction list
      • Users
        • Create Users
          • Create a Vessel Master user
        • Maintain Users
          • Change User Passwords
        • Find Users
        • Disable Users
      • Security Roles
        • Find Security Roles
        • Create Security Role
        • Maintain Security Roles
      • Security Groups
        • Find Security Groups
        • Create Security Group
        • Maintain Security Groups
      • Webhook Subscriptions
        • Create Webhook Subscription
        • Find Webhook Subscription
        • Maintain Webhook Subscription
          • Overview
          • Notification
      • Master Data
        • Company
        • User
      • Attachments
      • Audit Log
      • Bulk Update
      • Comments
      • Notifications
      • Sorting and Filtering Lists
    • Oracle Database Compatibility
  • Fleet Allocation & Scheduling
    • Getting Started
      • Capacity Plan (BETA)
      • Fleet Plans
        • Open Positions Board
        • Scheduler Board
        • Cargo Management Board
        • FAS Voyages List
        • Create Voyage and Cargo
      • Scenarios
      • Budgets
        • Create Budget Scenario
        • Template Voyages
          • Create Template Voyages
          • Find Template Voyages
          • Maintain Template Voyages
        • Budgeted Voyages
          • Find Budgeted Voyages
      • Voyage Actions
    • Step-by-step Guides
      • Voyages (Commitments)
        • Create Voyage Web
        • Create Commitment from Scratch
        • Create Commitment from CoA
        • Create Commitment from Voyage Estimate
      • Scenarios
        • Create Scenario
        • Maintain Scenario
  • Dataloy Distance Table (DDT)
    • About Dataloy Distances
    • Routing and routing options
    • High-Risk Area (HRA) / Piracy Routing
Powered by GitBook
On this page
  • Required fields
  • Expression

Was this helpful?

Export as PDF
  1. Voyage Management System
  2. VMS - Step by step guides
  3. Webhook Subscriptions

Create Webhook Subscription

Create Webhook Subscription Dialog

PreviousWebhook SubscriptionsNextFind Webhook Subscription

Last updated 2 years ago

Was this helpful?

  1. Open the Webhooks module in the Setup section.

  2. Click Create Webhook Subscriptionin the top right corner.

  3. Fill in all required fields listed below in the Create New Subscription window.

  4. Click Create.

Required fields

Field

Description

User

User to receive the notifications

Object Type

Name of the subscribed Dataloy object

Event Type

Type of event to Object

Alert Script

Subscribe to events based on the result of a DLPAlertScript.

Channel Type

Channel used to send notification

Url

Endpoint to receive the subscription

Field Conditions

A webhook subscription can only have an Object Type and an Event Type or an Alert Script. The corresponding fields are disabled to match this condition.

If the Channel Type chosen is HTTP, then the URL field must also be filled in.

Create Webhook Subscription Dialog

When choosing HTTP as Channel Type, you can also choose whether to add the Password, Access Token or Request Access Token fields.

Expression

On this input area, you can also write the expression by choosing in a menu the wanted field.

  1. Press dot ( . ) to see the menu.

  2. You can either scroll through the menu or type the wanted field.

  3. Choose the desired field. If the chosen is an object, the menu will now show the fields of that object.

A list of operators is also available by pressing the dollar sign ( $ ). Please make sure there is a space before and after the operator.

You can use the expression to check the previous value of the object.

  1. Press comma ( , ) to see the menu.

  2. You can either scroll through the menu or type the wanted field.

  3. Choose the desired field. Choosing a field from this menu will result in this format: old.chosenField. If the chosen field is an object, the menu will now show the fields of that object. Press "." for this menu and to continue to traverse the fields.

The expression created in this walkthrough will result in the following:

This expression will be translated in a way that you will get notified if the new voyage result is greater than the old voyage result.

This is an optional field to write a against the object changed.

Menu shown when "." is pressed
Operator list menu
Menu for the old object (after the operator > ) shown when "," is pressed.
Expression built
Java expression
Expression Input Area
Channel Type HTTP Options