Qu'est-ce que Webhook ?

Un webhook dans le développement Web est une méthode pour augmenter ou modifier le comportement d'une application Web, avec des rappels personnalisés. Ces rappels peuvent être maintenus, modifiés et gérés par des utilisateurs et développeurs tiers qui ne sont pas nécessairement affiliés à l'application d'origine.

QuestionPro prend en charge les webhooks entrants et sortants. Les webhooks peuvent être invoqués avant le début de l'enquête, pendant l'enquête (avant ou après une question) ou après la fin de l'enquête.

Que sont les webhooks entrants ?

Les Webhooks entrants sont un moyen simple de récupérer les données de sources externes dans votre sondage.

Que sont les webhooks sortants ?

Les webhooks sortants peuvent être utilisés pour envoyer des données d'enquête à une source externe. Ils utilisent des requêtes HTTP normales avec une charge utile JSON.

Comment mettre en place des webhooks ?

Pour créer un webhook :

Accédez à : Survey >> Integrations >> Webhooks

Cliquez sur le bouton Add New Webhook .
Entrez une description pour votre webhook
Sélectionnez le type requis (entrant / sortant)
Choisissez quand le webhook doit être appelé.
Cliquez sur Enregistrer les modifications

Une fois le webhook ajouté, vous devrez fournir les données requises pour effectuer l'appel d'API :

API URL: l'URL du point de terminaison pour effectuer un appel d'API.
Method: la méthode HTTP utilisée pour effectuer l'appel.
Request Header: champs d'en-tête HTTP qui sont des composants de la section d'en-tête de la demande
Request JSON: données utiles requises par l'API. Vous pouvez également utiliser le bouton Insérer une réponse pour insérer la réponse dans la requête JSON.

Une fois que vous avez rempli les détails ci-dessus, cliquez sur le bouton Save .

Comment utiliser les données récupérées d'un webhook entrant ?

Vous pouvez enregistrer les données extraites de la ressource externe en les mappant à des variables personnalisées. Pour ouvrir la boîte de dialogue de mappage, cliquez sur le bouton Add Custom Mapping :

Vous pouvez mapper les données à des variables personnalisées en attribuant des clés JSON individuelles à des variables personnalisées spécifiques. Vous pouvez également attribuer un nom pertinent aux variables personnalisées :

Une fois le mappage défini, les données collectées peuvent être affichées dans l'enquête à l'aide du code suivant : ${DisplayName}

Comment fournir des données pour un webhook sortant ?

En cas de webhooks sortants, vous pouvez envoyer les données collectées dans des variables personnalisées à un service Web externe en ajoutant les variables personnalisées sur le Request JSON :

Variables de remplacement de données

Pour récupérer les données des variables personnalisées, vous pouvez utiliser les balises suivantes pour les variables personnalisées correspondantes dans la requête JSON :

Variable personnalisée 1 : ${custom1}

Variable personnalisée 2 : ${custom2}

Variable personnalisée 3 : ${custom3}

Variable personnalisée 4 : ${custom4}

Variable personnalisée 5 : ${custom5}

Variable personnalisée N : ${customN}

Comment savoir si le Webhook a été exécuté avec succès ou a échoué ?

QuestionPro fournit une fonction de journalisation pour chaque webhook où vous pouvez vérifier les détails de l'API appelée par ce webhook ainsi que la charge utile et la réponse du point de terminaison. Pour accéder aux journaux, accédez à un webhook particulier et faites défiler vers le bas de la page où vous pouvez voir les demandes faites par ce webhook et en cliquant sur l'ID, vous pouvez vérifier les détails de tout appel spécifique.

De plus, si certains appels sortants n'ont pas réussi à transmettre les données, un bouton Réessayer manuellement sera disponible devant ces appels d'API sur lequel vous pouvez cliquer à tout moment pour renvoyer les données au point de terminaison de l'API.