| Scroll export button | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Info |
|---|
This guide explains how to configure Webhook integration with third-party web applications and services, for sending events related to calls. Created: August 2023 Updated: September 2024January 2025 Permalink: https://wildix.atlassian.net/wiki/x/AYCODg |
...
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 Add new integration:
3. On the New webhook 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 URL field, indicate the URL where the data should be sent to.
Secret is generated automatically and cannot be edited.
Note Note: The endpoint should be publicly accessible with a valid HTTPS certificate, accept HTTP POST requests with JSON payloads, respond with codes from 200 to 299 as quickly as possible, and handle multiple identical calls in case of retries due to network or server failures (up to 3 times).
- Choose types of events:
- Call events
- Conference events
- Chat events
- Analytics events
- Presence events
By clicking on the event type, you can view the list of events and choose if you want to use all events in the list or only the selected ones:
Depending on the number of chosen events the checkbox in front of event type may look differently: dash icon (1) if not all events were selected and checkmark (2) in case all the events within a particular event type are used:
Analytics events:
Call / conference transcription and summary completed events allow to pass the full text of call / conference transcription and summary.
The events call:transcription:text:completed / conference:transcription:text:completed store the transcription in text format. While rest of the events (call:transcription:completed, call:summary:completed, conference:transcription:completed, conference:summary:completed) have data in JSON format.
Presence events:
Presence events return 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)
| Note |
|---|
Note: For PBXs with Collaboration licenses, an additional configuration is needed for sending presence:user and presence:telephony events. Please follow the instructions in the guide Custom config parameters List (see the section namedEnable Presence events sending for Webhook integration) On PBXs with x-bees license, sending of presence:user and "presence:telephony events is active by default. |
4. Click Add
Once installed, you can see details about the new integration which includes type, URL, and types of events selected.
b) In case of AWS SQS transmission type:
- In the SQS URL field, indicate the SQS URL where the data should be sent to.
- Enter AWS Key and Secret in the relevant fields.
- Choose types of events:
- Call events
- Conference events
- Chat events
- Analytics events
- Presence events
By clicking on the event type, you can view the list of events and choose if you want to use all events in the list or only the selected ones:
Depending on the number of chosen events the checkbox in front of event type may look differently: dash icon (1) if not all events were selected and checkmark (2) in case all the events within a particular event type are used:
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 Add.
How to manage WebHook integrations
Once installed, you can see details about the new integration which includes type, URL, and types of events selected:
...