Setting a Webhook

A webhook is a connector used to send your call data (such as new received calls, …) from your account to other Web apps of daily use (your CRM, internal chat, ERP, IS, …).

The point is for you to be notified directly in third-party applications without using Web services, which are a different way to do this and can be more complex to configure. Please note that webhooks can only send call data from your account to your applications in one way.

Example of new call notification via webhook

How to activate webhooks in your account

Before adding and configuring new webhooks, you need to activate the Webhooks feature for your whole account.

To do this, get to the Integrations tab, and click on Activate for Webhooks.

Then you are taken to the list of your webhooks, for now empty but soon completed with your new webhooks to come.

How to add a new webhook

To add a new webhook, click on the Add New button, at the top right of the webhooks list.

Then, type down the name of your webhook and the URL that will receive the notifications from your account via the webhook.

If you are using a third-party software for webhook connectors (e.g. Zapier), payload URL is directly provided in this software’s environment, once the connector is set. If you are setting webhooks to notify custom applications, payload URL stands for the URL of the page that will be notified.

Then, the next field in the form is Event. Select here the type of event to be sent into your Web app:

• cdr (Call Detail Report): at the end of phone conversation, the call data is sent via the webhook.
• call: you are notified of every new received call.
• user: you are notified of every action completed in your account by a declared user of the account.

Next comes the Active box. Keep it checked or uncheck it whenever you want to pause your webhook.

And finally, the Restrict to field is for activating your webhook for a specific tracking number or user.

If you previously selected cdr or call as event type, select Restrict to – Tracking Number, and then choose in the list of your available tracking numbers the numbers to activate your webhook for.

If you selected user as event type, select Restrict to – User, and then choose in the User field that appears the user to activate your webhook for.

Then, click on Create to save your webhook in the webhooks list.

How to view webhook data in your account

Here is how webhooks are displayed in the list. The Deliveries column is for the number of times a notification has been sent with this webhook.

To view the details of the call data sent with a webhook, click on the Deliveries icon in the Actions column. Same way, click on the Edit icon to modify a webhook, and on the Delete icon to definitely remove a webhook from your account.

From left to right: Deliveries, Edit and Delete icons

How to display webhook details

By clicking on Deliveries icon for a specific webhook on the list, a summary of the data sent with this webhook is displayed. Click on the period selector above the table to show the data recap for this period only.

Data sending has been processed successfully by the webhook if the icon in the Status column is green.

Click on the Consultation icon in the Actions column to view all the data code sent by the webhook.