🖍️
Dataloy VMS API Documentation
API Release 8.6
API Release 8.6
  • Dataloy VMS API
  • Dataloy Rest API
    • What is it?
    • Authentication / Authorization
    • Getting Started
    • Data Model
    • Filtering
    • Sorting
    • Pagination
    • Adjust Number of Fields to be Returned from a Request
    • Webhooks
      • Webhook example
      • Expressions Made Easy
      • Webhooks - New functionalities
    • Master data Objects
    • Attachments
    • Audit Log
  • User Guides
    • Accounting Integration API
      • Invoicing
      • Payments/Receipts
      • Voyages
      • Business Partners
      • Exchange Rates
      • Bunker Transactions
      • Actuals
      • Autopost Invoices
      • Accruals
    • Schedule API
    • Bunker Order Integration API
    • Service Order Integration API
    • Vessel Report
      • Overview
      • Legacy version (6.26 - 6.28)
      • Vessel report master data
    • Bunker Consumption API
    • Left join in API queries
    • Enterprise functionalities
      • Versioning
      • Endpoint access control
      • Data access control via target object
      • Data access control via target object and security role
      • Data access control at object level
      • Fields access control
      • Alert Scripts
      • Websockets
      • Bulk Deletion
      • Copy objects
      • OR and AND operators in API queries
      • Sub queries
      • XML Transformation
      • Expressions
      • Bulk Update
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Dataloy Rest API
  2. Webhooks

Webhook example

PreviousWebhooksNextExpressions Made Easy

Was this helpful?

Get updates for nominated and operational voyages in Master scenario:

{
    "eventType":"U",
    "user": "your user code",
    "objectType":"Voyage",
    "expression": "dlpObject.getVoyageHeader() != null && (dlpObject.getVoyageHeader().getVoyageStatus().getStatusTypeCode().equals(\"NOM\") || dlpObject.getVoyageHeader().getVoyageStatus().getStatusTypeCode().equals(\"OPR\")) && dlpObject.getVoyageHeader().getIsBudget().equals(false) && dlpObject.getVoyageHeader().getIsTemplate().equals(false) &&dlpObject.getVoyageHeader().getIsEstimate().equals(false) && dlpObject.getVoyageHeader().getIsUnallocated().equals(false) && dlpObject.getScenarios() != null && dlpObject.getScenarios().size() > 0 && dlpObject.getScenarios().get(0).getScenarioCode().equals(\"MASTER\")",
    "onlyMainObject": true,
    "url": "",
    "webhookUsername": "",
    "webhookPassword": ""
}

Get notification when an invoice is posted and ready to be transferred to accounting. Set the status to Posted when it's transferred to accounting. For more information about accounting integration see:

{
    "eventType":"U",
    "user": the user code to be used in the subscription,
    "objectType":"Document",
    "expression": "dlpObject.getInvoicingStatus() != null && dlpObject.getInvoicingStatus().getStatusTypeCode().equals(\"RFP\") && (dlpObject.getDocumentType().getDocumentType().equals(\"INO\") || dlpObject.getDocumentType().getDocumentType().equals(\"INI\") || dlpObject.getDocumentType().getDocumentType().equals(\"CRI\") || dlpObject.getDocumentType().getDocumentType().equals(\"CRO\"))",
    "onlyMainObject": true,    
    "url": "your webhook url"
}
{
    "eventType":"U",
    "user": the user code to be used in the subscription,
    "objectType":"Document",
    "expression": "dlpObject.getInvoicingStatus() != null && dlpObject.getInvoicingStatus().getStatusTypeCode().equals(\"RFP\") && (dlpObject.getDocumentType().getDocumentType().equals(\"ACR\") || dlpObject.getDocumentType().getDocumentType().equals(\"ACP\"))",
    "onlyMainObject": true,    
    "url":"your webhook url"
}

Get notified when accruals are posted and and ready to be transferred to accounting. Set the status to Posted when it's transferred to accounting. For more information about accounting integration see:

https://dataloy-cloud.atlassian.net/wiki/spaces/VMSINT/pages/923414837
https://dataloy-cloud.atlassian.net/wiki/spaces/VMSINT/pages/923414837