Webhook

Webhooks allows you to receive real-time HTTP notifications of changes to specific objects in Venio.

Webhook Payload Object

modifiedBy: string
The employee code of user who created the webhook

webhookName: string
The name of webhook configured in the integration setting

topic: string
The topic that caused the webhook to fire

Allowed Values : Customer, Quotation, Expense, User, Payroll, Case, Deal

event: string
The event that caused the webhook to fire

Allowed Values : Create, Merge, Convert, Revise, Paid, PendingSummary, Inactive, Completed, Edit, MoveStage

data: object
Provides the changes data related to topic and event

Data Object

Owners: array of string
The owners user of the tranasction

Topics : Customer, Quotation, Case, Deal
Events : Create, Convert, Revise, Completed, Edit, MoveStage

FromCustomerCode: string
The customer code of the source data when merging customer records

Topics : Customer
Events : Merge

FromCustomerName: string
The customer name of the source data when merging customer records

Topics : Customer
Events : Merge

ToCustomerCode: string
The customer code of the destination data when merging customer records

Topics : Customer
Events : Merge

ToCustomerName: string
The customer name of the destination data when merging customer records

Topics : Customer
Events : Merge

customerName: string
The customer's name

Topics : Customer, Deal
Events : Create, Convert, Edit, MoveStage

CustomerCode: string
The customer's code

Topics : Customer, Deal
Events : Create, Convert, Edit, MoveStage

QuotationNo: string
The quotation running number

Topics : Quotation
Events : Create, Revise

SaleOrderNo: string
The quotation running number

Topics : SaleOrder
Events : Create, Edit, Completed

ExpenseNo: string
The expense running number

Topics : Expense
Events : Paid, PendingSummary

CreatedBy: string
The employee's code who performed the action

All topics and events

CompanyName: string
The companyName's name

Topics : User, Payroll
Events : Inactive, Paid

EmployeeRefId: string
The employee's no

Topics : User
Events : Inactive

PeriodCalculateNo: number
The periodCalculateNo of payroll

Topics : Payroll
Events : Paid

Year: number
The year of payroll

Topics : Payroll
Events : Paid

IsExtendPeriod: boolean
IsExtendPeriod for checking the period of extend periods or regular periods
true -> extend periods, false -> regular periods

Topics : Payroll
Events : Paid

CaseNo: string
The case running number

Topics : Case
Events : Create, Edit, Completed

ChatMessage: object
The chat message object model

Topics : Chat
Events : Message

ActivityNo: string
The activity running number

Topics : Activity
Events : Create, Edit, Completed

ActivityName: string
The activity name

Topics : Activity
Events : Create, Edit, Completed

AssignedTo: string
The employee's code who assigned to action

Topics : Activity
Events : Create, Edit, Completed

ProductCode: string
The product code

Topics : Product
Events : Create, Edit

ProductName: string
The product name

Topics : Product
Events : Create, Edit

DealNo: string
The deal running number

Topics : Deal
Events : Create, Edit, MoveStage

DealName: string
The deal name

Topics : Deal
Events : Create, Edit, MoveStage

DealStage: string
The current stage of the deal. For a closed deal it is the status name: Won, Missed or Cancelled

Topics : Deal
Events : Create, Edit, MoveStage

PreviousDealStage: string
The stage of the deal before it was moved

Topics : Deal
Events : MoveStage

BoardId: number
The id of the deal board (pipeline) the deal belongs to. Not included when the deal has no board

Webhook Payload

Webhook

Webhook Payload Object

Data Object

Examples webhook payload

Create Customer

Merge Customer

Create Quotation

Expense Paid

Expense PendingSummary

Inactive User

Payroll Paid

Create Sale Order

Edit Sale Order

Completed Sale Order

Edit Asset

Transfer Asset

Create Case

Edit Case

Closed Case

Chat Message

Create Activity

Edit Activity

Completed Activity

Create Product

Edit Product

Create Deal

Edit Deal

Move Deal Stage

Won Deal

Webhook Payload

Webhook#

Webhook Payload Object#

Data Object#

Examples webhook payload#

Create Customer#

Merge Customer#

Create Quotation#

Expense Paid#

Expense PendingSummary#

Inactive User#

Payroll Paid#

Create Sale Order#

Edit Sale Order#

Completed Sale Order#

Edit Asset#

Transfer Asset#

Create Case#

Edit Case#

Closed Case#

Chat Message#

Create Activity#

Edit Activity#

Completed Activity#

Create Product#

Edit Product#

Create Deal#

Edit Deal#

Move Deal Stage#

Won Deal#

Webhook

Webhook Payload Object

Data Object

Examples webhook payload

Create Customer

Merge Customer

Create Quotation

Expense Paid

Expense PendingSummary

Inactive User

Payroll Paid

Create Sale Order

Edit Sale Order

Completed Sale Order

Edit Asset

Transfer Asset

Create Case

Edit Case

Closed Case

Chat Message

Create Activity

Edit Activity

Completed Activity

Create Product

Edit Product

Create Deal

Edit Deal

Move Deal Stage

Won Deal