Versions Compared

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

...

1. Go to WMS -> PBX -> Integrations -> Calendars tab (or to x-bees tab in case of a PBX with x-bees licence) 

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

    Image Added

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
      Image Removed
      Image Added

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

Image Added

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: 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, look for the x-signature field in the header section _____ and use it to validate the body section. See example of the code below:

Image Added

Response example

Code Block
{
success:true,
result:[
{companyId:'wildix_srl',type:'sqs',url:'',key:'',secret:'',filter:['call:start']},
{companyId:'it_w118741',type:'webhook',url:'',key:'',secret:'',filter:['call:start',call:end', 'call:update']}
],
}


...