| Scroll export button | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
Introduction
Webhook integration (currently, in Beta) allows to connect allows to connect different third-party web applications and services by sending events related to calls.
...
1. Go to WMS -> PBX -> Integrations -> Cloud integrations tab
| Note |
|---|
Note: In case of WMS version lower than 6.05.20240119.1, the tab is named Calendars (or x-bees in case of a PBX with x-bees license). |
2. Click on the Webhook integration -> click Install
3. On the Connect integration screen, fill out the following fields:
Select transmission type for sending the events:
- WebHook: POST requests are sent to the URL, specified by customer
- AWS SQS: events are sent to AWS SQS queue
a) In case of WebHook transmission type:
- In the Target field, indicate the URL where the data should be sent to.
- Secret is generated automatically and cannot be edited.
- Choose type of events:
- Call start
- Call update
- Call end
- User presence
- User presence telephony
User presence returns user status (e.g. Available, Away, Busy) status message and time, as well as location. For the User presence telephony option, the following statuses are supported:- registered (registered and idle)
- ringing (in ringing state)
- talking (in conversation)
- rt (in conversation and ringing state)
b) In case of SQS transmission type:
- In the Target field, indicate the SQS URL where the data should be sent to.
- Enter SQS Key and Secret in the relevant fields.
- Choose type of events:
- Call start
- Call update
- Call end
- User presence
- User presence telephony
User presence returns user status (e.g. Available, Away, Busy) status message and time, as well as location. For the User presence telephony option, the following statuses are supported:
- registered (registered and idle)
- ringing (in ringing state)
- talking (in conversation)
- rt (in conversation and ringing state)
4. Click Install.
Once installed, you can see details about the new integration which includes Integration ID, Transmission type, URL, Secret, and types of events selected.
| Note |
|---|
Note: Editing of the integration is currently not supported. If you need to update any data, please delete the current Webhook integration and create a new one. |
Copy the Integration ID and use it in your web application / service.
| Warning |
|---|
Important: The timeout for Webhook reply is 5 seconds. |
| Warning |
|---|
Important: For security reasons, it is highly recommended that you validate the data received to your web application / service and make sure the data comes from Wildix and the data is not broken. For this, check `signature` for all received events:
|
Configuration example
See Webhook configuration example on this page.
...