WebHook Event Types

Modified on Wed, 30 Apr at 6:39 PM

After clicking on the "New Web hook" button, the following types will be available in the modal window that opens to create a webhook event:

Push Notification- allows applications to send notifications to mobile devices even when they are closed or in the background. Messages can include a variety of content and can be customised for specific users or groups.
Adding Equipment Connection Address (deviceAddressEventName) - defines and communicates information about device IP address changes, which helps to keep network settings and security up to date.
FlashCall (Authorisation call) - used to confirm the user's identity. When logging in or performing an action requiring confirmation, the system makes a call to the registered number and the user enters the displayed number for confirmation.
Password call (Authorisation call) - used to confirm the user's identity when logging in or performing important actions. The system calls the registered number and the user confirms his/her identity by entering the code from the call.
Balance - notifies the user's current balance status in the system, tracking changes and allowing you to take action, such as a top-up or low balance notification.
VPBX: End of an incoming call - Notifies you when an incoming call is completed, capturing call information such as time and duration for analysis and reporting.
VPBX: End of a call to the internal number - reports the end of a call to an extension, allowing you to capture information for internal record keeping and analysis.
VPBX: End of outbound call - notifies you when an outbound call is completed, capturing data for analysis and reporting.
Outgoing call answered (VPBX)- reports that an outgoing call has been answered, allowing you to record successful connections.
VPBX: Start of inbound call - notifies you when an incoming call starts, capturing data for later analysis.
VPBX: Start of a call to the internal number - reports the start of a call to an extension, capturing the information for internal accounting.
VPBX: Start of outbound call - notifies you when an outgoing call has started, capturing data for later analysis.
VPBX: Start of call forwarding - reports the start of call forwarding, capturing information for analysis and routing optimisation.
VPBX: End of forwarded call - notifies that a forwarded call has been received, capturing data to analyse the success of forwarded calls.
VPBX: Transferring a call from an internal number - reports the transfer of a call from an internal number, capturing the information for internal record keeping and analysis.
FAX recieved (VPBX) - notifies you when a fax is received, capturing the data for later analysis and record keeping.
VPBX: Replica of item: \"Question-Answer\" - reports the completion of a Q&A scenario, capturing data for analysing interactions.
VPBX: End of forwarded call - notifies about call forwarding completion, capturing data for routing analysis.
Customer Verification - used to confirm customer identity through various verification mechanisms such as SMS or call.
SMS - notifies about incoming or outgoing SMS, capturing information for analysis and reporting.
Automated calls event - reports the start of a call initiated by a voice robot, capturing data for analysis.
Call event for automated calls - notifies events from the voice robot, capturing data to analyse performance.
Call recording available - reports when the conversation record file is ready, allowing the user to access the recording for analysis and reporting.
Information about call recording - notifies you when the speech analytics analysis is complete, capturing the results for future reference.
End of incoming call (Telephony) - reports the completion of an incoming call, capturing data for analysis and reporting.
New dialog event at multichat - notifies you when a multichat dialogue has ended, capturing information for analysis of interactions.
Call ended on queue - reports the completion of a call in the queue, capturing data to analyse and optimise queue performance.
End of outbound call (Telephony) - notifies you when an outbound call is completed, capturing data for analysis and reporting.
End of forwarded call (Telephony) - reports the completion of a forwarded call, capturing data for routing analysis.
Transcription has finished - notifies you when transcription is complete, capturing data for later use and analysis.
Call from quest region - reports a call from a guest region, capturing data for analysis and reporting.
Call from Call Tracking - notifies you of a call received via calltracking, capturing data to analyse marketing campaigns.
Change of Counterparty Status - reports changes in counterparty status, capturing information for accounting and analysis.
Information about call recording - notifies you when a call recording is ready, allowing you to access the recording for analysis and reporting.
Telephony: Outbound call answered - reports that an outgoing call has been answered, capturing data to analyse the success of connections.
Start of inbound call - notifies you when an incoming call starts, capturing data for later analysis.
Starting a call to extension number in the queue - reports the start of a call to an internal number in the queue, capturing data for internal accounting.
Starting a call via API - notifies the start of a call initiated via API, capturing data for analysis.
Start of call in the queue - reports the start of a call through the queue, capturing data to optimise queue performance.
Start of outbound call - notifies you when an outgoing call has started, capturing data for later analysis.
Sart of a forwarded call in telephony - reports the start of a forwarded call, capturing data for routing analysis.
Phone call answered - notifies you when a call is answered, capturing data to analyse the success of connections.
Queue call answered - reports call acceptance through the queue, capturing data to analyse and optimise queue performance.
Sending variables from the VPBX scenario - notifies you when variables are sent from a BATS script, capturing the data for later analysis and use.
Speech recognition result - reports speech recognition events, capturing data for analysis and system improvement.
Client registration - notifies the registration of a new customer, capturing data for accounting and analysis.
Speech synthesis - reports speech synthesis events, capturing data for analysis and system improvement.
Account's event - notifies you of various events related to a user's account, capturing data for record keeping and analysis.
New dialog event at multichat - reports the creation of a new multichat dialogue, capturing data for interaction analysis.
Creating a new chatbot user - notifies you when a new chatbot user is created, capturing data for accounting and analysis.
SMS Billing- reports the SMS charge, capturing data for accounting and analysis.
Subscriber Status - notifies the subscriber's status, capturing data for later analysis and use.