Configurer un Webhook

Un webhook sert à transmettre vos données d’appel depuis votre compte (nouvel appel reçu, …) vers les outils que vous avez l’habitude d’utiliser au quotidien (CRM, outils de collaboration interne, ERP, SI, …).

L’objectif d’un webhook est de vous notifier directement dans des applications tierces sans avoir recours aux services Web, qui peuvent être plus difficiles à mettre en place. À noter que les webhooks permettent uniquement d’envoyer des données d’appel de votre compte vers vos applications, mais ne permettent pas d’en recevoir en sens inverse.

01-Configurer-un-webhook-1

Exemple de notification de nouveaux appels reçus via un webhook

Pré-requis :
– L’intégration Webhooks est disponible uniquement pour les comptes disposant d’un plan tarifaire Pro ou Enterprise.

Activer les webhooks dans votre compte 

Avant d’ajouter et de configurer des webhooks, il est nécessaire d’activer la fonctionnalité pour l’ensemble du compte.

Pour cela, rendez-vous dans l’onglet Intégrations, et cliquez sur la carte Webhooks.

Presentation-des-integrations-disponibles3

Cela affiche alors la liste des webhooks disponibles, dans laquelle vous retrouverez tous les webhooks que vous allez ajouter au fur et à mesure dans votre compte.

Ajouter un webhook

Pour ajouter un nouveau webhook, cliquez sur le bouton Ajouter, situé en haut à droite de la liste des webhooks.

Vous êtes ensuite invité à entrer le nom de votre webhook, ainsi que l’URL à laquelle les notifications seront envoyées via le webhook.

04-Ajouter-un-webhook-2

 

Si vous utilisez des solutions tierces qui fournissent des connecteurs (ex : Zapier), l’URL est à récupérer directement dans cette solution lorsque le connecteur est configuré. Dans le cas des webhooks paramétrés pour notifier des outils propriétaires, l’URL à renseigner correspond à celle de la page que vous souhaitez notifier.

Dans la suite du formulaire, le champ Événement correspond au type d’événement pour lequel vous souhaitez être notifié. Sélectionnez le type d’événement parmi les suivants :

  • cdr (pour Call Detail Record) : en fin de conversation, le webhook transmet les informations de l’appel.
  • call : vous êtes notifié grâce au webhook à chaque appel reçu.
  • user : vous êtes notifié grâce au webhook de chaque action réalisée dans le compte par un utilisateur déclaré de votre compte.

La case Activé peut être cochée ou décochée à tout moment si vous souhaitez mettre votre webhook en pause.

Enfin, le champ Restreindre à vous permet de limiter l’action du webhook à un numéro de tracking ou un utilisateur spécifique.

Si vous avez sélectionné cdr ou call comme type d’événement, choisissez Restreindre à – Numéro de Tracking, puis sélectionnez dans la liste de vos numéros de tracking disponibles ceux sur lesquels s’appliquera l’action du webhook.

05-Ajouter-un-webhook-3

Si vous avez sélectionné user comme type d’événement, choisissez Restreindre à – Utilisateur, ensuite sélectionnez l’utilisateur pour lequel s’appliquera l’action du webhook.

Cliquez ensuite sur Créer pour enregistrer votre webhook et le voir apparaître dans la liste.

Consulter un webhook dans votre compte

07-Consulter-un-webhook-dans-votre-compte-1

Voici comment s’affiche la liste une fois les premiers webhooks configurés dans votre compte. La colonne Livraisons vous indique le nombre de fois où la notification a été envoyée via le webhook.

Pour consulter le détail des informations envoyées, cliquez sur l’icône Livraisons dans la colonne Actions. Dans cette même colonne, cliquez sur l’icône Modifier pour éditer un webhook, et sur l’icône Supprimer pour le retirer définitivement du compte.

08-Consulter-un-webhook-dans-votre-compte-2

De gauche à droite : icône Livraisons, icône Modifier, icône Supprimer

Afficher les détails d’un webhook 

Lorsque vous cliquez sur l’icône Livraisons pour un webhook dans la liste, un tableau récapitulatif des envois de ce webhook s’affiche. Cliquez sur le sélecteur de période au-dessus du tableau pour filtrer les envois sur la plage de dates qui vous intéresse.

09-Afficher-les-details-d-un-webhook-1

Si l’icône dans la colonne Statut apparaît en vert, l’envoi de l’information souhaitée a été effectué avec succès via le webhook.

En cliquant sur l’icône Consultation dans la colonne Actions, vous pouvez visualiser l’intégralité des informations envoyées par le webhook sous forme de code.

10-Afficher-les-details-d-un-webhook-2

 

Exemples de données envoyées 

 

Événement CDR Événement CALL
logs cdr event logs call event