Versions Compared

Old Version 20

changes.mady.by.user Tatiana Bieliakova

Saved on

compared with

New Version Current

changes.mady.by.user Tatiana Bieliakova

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Scroll export button
scopecurrent
template-id0fa09813-8b86-460a-aa1d-ef450a80e9ce
quick-starttrue
add-onScroll PDF Exporter

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: February March 2024

Permalink: https://wildix.atlassian.net/wiki/x/AYCODg

...

1. Go to WMS -> PBX -> Integrations -> Calendars stab (or to x-bees tab 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

licence

license).


Image RemovedImage Added

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:

  1. In the Target field, indicate the URL where the data should be sent to. 
  2. Secret is generated automatically and cannot be edited. 
  3. Choose type of events: 
    1. Call start
    2. Call update
    3. Call end
    4. User presence
    5. 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:

  1. In the Target field, indicate the SQS URL where the data should be sent to.
  2. Enter SQS Key and Secret in the relevant fields. 
  3. Choose type of events: 
    1. Call start
    2. Call update
    3. Call end
    4. User presence
    5. 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:

  • For webhook transport, you can find signature in the request's header x-signature
  • For SQS transport, you can find signature in the MessageAttributes ['X-SIGNATURE']

Configuration example

See Webhook configuration example on this page.


...