Les notions d’API et de webhook commencent progressivement à faire partie du jargon business notamment avec la démocratisation du Nocode.

Pour autant, il peut être compliqué de les appréhender. C’est ce qu’on va tenter de vous expliquer dans cet article. Nous allons aussi parler de comment configurer un webhook en temps général et sur Discord. Et quels sont les méthodes pour utiliser le webhook dans le développement d'une infrastructure.

Webhook : Qu’est-ce que c’est ?

Souvent appelé “Reverse API” ou encore “HTTP callback”, le webhook est un outil qui permet de déclencher une action lorsqu’un événement déterminé se produit.

Pour rentrer un peu dans la technique, le webhook est en fait une requête HTTP de type POST qui va envoyer des informations (des données) par le biais d’une URL pour un événement précis.

Ces données sont généralement envoyées dans une structure de données JSON - qui permet aux outils de les traiter.

Quels sont les cas d’usage ?

Les cas d’usage sont très nombreux. En voici quelques exemples :

• Création d’un nouveau contact dans votre CRM ainsi que l’envoi d’une notification Slack à l’équipe commerciale lorsqu’un utilisateur remplit un formulaire sur votre site.
• Création d’une facture et envoi de mail automatisé lorsqu’un utilisateur achète un produit sur votre site.
• Envoi d’une notification à l’équipe Customer Success lorsque la période d’essai d’un utilisateur se termine.

Vous l’aurez compris, les webhooks sont un outil aujourd’hui indispensable pour automatiser des tâches à forte valeur ajoutée à partir d’un événement, autrement dit “trigger”.

Les avantages de l'utilisation d'un webhook

Les webhooks présentent de nombreux avantages pour les développeurs et les utilisateurs de systèmes d'information. Voici cinq points principaux :

• Automatisation des processus : Les webhooks permettent d'automatiser des processus en envoyant des données en temps réel dès qu'un événement se produit. Cela élimine le besoin de programmer des demandes d'information régulières pour vérifier si un événement s'est produit.
• Efficacité en temps réel : Les webhooks fournissent des informations dès qu'un événement se produit. Cela signifie que vous obtenez des données en temps réel, ce qui peut être crucial pour certaines applications.
• Économie de ressources : Au lieu de faire constamment des requêtes pour vérifier les mises à jour, les webhooks envoient des données uniquement lorsqu'il y a quelque chose de nouveau. Cela réduit la charge sur vos serveurs et économise des ressources.
• Personnalisable : Les webhooks sont hautement personnalisables. Vous pouvez définir le type d'événements pour lesquels vous souhaitez recevoir des notifications, et les données que vous souhaitez recevoir.
• Intégrations facilitées : Les webhooks facilitent l'intégration de différents systèmes logiciels. Ils peuvent être utilisés pour connecter des applications, des services ou des plateformes qui n'ont pas été initialement conçus pour travailler ensemble.

Webhook vs API : Quelle différence ?

Il est vrai qu’on peut rapidement s’y perdre parmi ces différents concepts. Le webhook et l’API se ressemblent dans le sens où ils permettent tous les deux de faire transiter des données entre deux outils.

La différence se fait davantage dans le “comment”. Nous avons vu dans la partie précédente que le webhook se basait sur des événements. L’API est-elle “request-based”, c’est-à-dire basée sur une requête. Ici, nous allons cette fois interroger un outil pour récupérer des données - dans le cadre d’une requête GET. C’est ce qu’on appelle le “polling”, autrement dit le “sondage”.

À savoir qu’il existe quatre types de requêtes : GET, POST, PUT, DELETE. Mais ce n’est pas si important dans le cadre de cet article.

On va privilégier les APIs lorsque l’on doit gérer des changements constants dans les données. En effet, à chaque fois que vous allez sonder le service, de nouvelles informations vont être récupérées. On peut prendre l’exemple des données issues des campagnes publicitaires telles que Facebook Ads ou Google Ads.

Avoir recours à une API n’aurait pas de sens par rapport aux Webhooks dans le cadre de la génération d’une facture. Effectivement, l’objectif ici est de déclencher une action instantanément plutôt que d’interroger à intervalles réguliers le service pour savoir si un client a acheté un produit ou non.

Voici une illustration qui vous permettra de mieux visualiser le mécanisme et la différence.

‍

Les usages sont totalement différents donc il n’est pas pertinent de vouloir comparer les deux. Tout dépend de l’objectif et du type de data que vous souhaitez manipuler.

Comment configurer un webhook ?  

La configuration d'un webhook dépend du système que vous utilisez. Cependant, le processus général est similaire sur la plupart des plateformes. Voici les étapes générales pour configurer un webhook :

1. Identifiez l'outil ou la plateforme qui enverra les données via le webhook. Assurez-vous que cet outil ou cette plateforme prend en charge les webhooks.
2. Dans l'outil ou la plateforme qui envoie les données, recherchez les paramètres ou les configurations liés aux webhooks. Cela peut être dans les paramètres de l'application ou dans une section dédiée aux intégrations.
3. Créez un nouvel endpoint de webhook dans l'outil ou la plateforme. Il s'agit de spécifier une URL spécifique qui recevra les données envoyées par le webhook. Généralement, vous devrez également spécifier des informations supplémentaires telles que le nom, la description, et éventuellement des paramètres de sécurité comme une clé d'authentification.
4. Configurez les événements ou les déclencheurs qui déterminent quand les données doivent être envoyées via le webhook. Vous pouvez spécifier des conditions ou des événements spécifiques qui déclenchent l'envoi des données. Par exemple, il peut s'agir de la création d'un nouvel enregistrement, de la modification d'une donnée existante, ou de la réalisation d'une action spécifique.
5. Si nécessaire, configurez l'authentification pour le webhook. Certains webhooks exigent une authentification pour garantir que seules les applications autorisées peuvent recevoir les données. Dans ce cas, vous devrez peut-être générer une clé d'authentification ou configurer des paramètres de sécurité supplémentaires.
6. Une fois que le webhook est configuré, assurez-vous de tester son fonctionnement. Vous pouvez utiliser des outils de test de webhook ou effectuer des tests manuels en déclenchant les événements appropriés dans l'outil ou la plateforme.
7. Lorsque les données sont envoyées via le webhook, elles sont généralement transmises en utilisant une structure de données spécifique, comme JSON. Assurez-vous de comprendre le format des données et comment les extraire et les traiter dans votre application ou votre système récepteur.

Nous allons maintenant donner un exemple en détaillant comment configurer un webhook facilement sur discord.

Comment configurer un webhook sur discord ?

Voici les étapes :

1. Ouvrez Discord : Ouvrez votre application Discord et allez dans le serveur où vous souhaitez configurer le webhook.
2. Accédez aux paramètres du serveur : Cliquez avec le bouton droit de la souris sur le nom du serveur situé en haut à gauche de l'écran et sélectionnez "Paramètres du serveur".
3. Accédez à la section Webhooks : Dans le menu de gauche, recherchez et sélectionnez l'option "Webhooks".
4. Créez un nouveau Webhook : Cliquez sur le bouton "Créer un Webhook". Vous serez redirigé vers une nouvelle page pour configurer votre Webhook.
5. Configurez votre Webhook :
6. Nom : Donnez un nom à votre Webhook. Ce sera le nom qui apparaîtra chaque fois que le Webhook postera un message.
7. Canal : Sélectionnez le canal sur lequel vous souhaitez que le Webhook poste des messages.
8. Avatar : Vous pouvez également télécharger une image pour représenter votre Webhook.
9. Copiez l'URL du Webhook : Une fois que vous avez terminé de configurer votre Webhook, copiez l'URL du Webhook qui est générée. Vous utiliserez cette URL pour envoyer des messages via le Webhook.
10. Enregistrez vos modifications : Cliquez sur le bouton "Enregistrer" en bas de la page pour enregistrer vos modifications.

Les webhooks pour le développement de l'infrastructure

Les webhooks sont généralement employés pour faciliter les interactions entre deux programmes ou applications, cependant, ils peuvent aussi être utilisés pour automatiser des processus IaC (Infrastructure-as-code) et mettre en œuvre des méthodes GitOps.

Processus IaC

L'Infrastructure-as-Code, ou IaC, est une méthode de gestion et de provisionnement des infrastructures informatiques par le biais de fichiers de définition lisible par machine, plutôt que par des configurations matérielles physiques ou des outils de configuration interactive.

En d'autres termes, il s'agit d'écrire du code (qui peut être vérifié dans un système de contrôle de version) pour définir et gérer votre infrastructure, au lieu d'utiliser des interfaces utilisateur graphiques ou des commandes manuelles.

Voici quelques points clés sur l'IaC :

1. Automatisation : L'IaC permet d'automatiser le processus de configuration, ce qui rend le déploiement de l'infrastructure plus rapide et moins sujet aux erreurs humaines.
2. Consistance : L'infrastructure est définie en utilisant un langage de haut niveau, ce qui permet de garantir la consistance et la reproductibilité de l'infrastructure.
3. Versionnage : Comme tout autre code, l'IaC peut être mis dans un système de contrôle de version. Cela permet de suivre les modifications, de revenir à une version précédente si nécessaire, et de collaborer plus facilement.
4. Documentation : Le code lui-même devient une forme de documentation de l'infrastructure. Il décrit précisément ce qui a été déployé.
5. Intégration et déploiement continu : L'IaC s'intègre bien avec les pratiques de développement logiciel telles que l'intégration continue/déploiement continu (CI/CD), ce qui permet des mises à jour et des modifications d'infrastructure plus fluides.

Des outils comme Terraform, Ansible, Chef, Puppet et AWS CloudFormation sont couramment utilisés pour mettre en œuvre l'IaC.

Processus GitOps

GitOps est une méthode de mise en œuvre de l'infrastructure qui utilise les systèmes de contrôle de version Git comme source unique de vérité pour l'infrastructure et les applications. GitOps est souvent associé à Kubernetes, mais le concept peut s'appliquer à d'autres systèmes aussi.

Voici quelques points clés sur GitOps :

1. Déploiements basés sur Git : Dans une approche GitOps, toutes les modifications de l'infrastructure et des applications sont effectuées via des commits dans un dépôt Git. Cela signifie que toutes les modifications sont traçables, réversibles et peuvent être soumises à un examen par les pairs.
2. Automatisation : Les outils de GitOps surveillent constamment le dépôt Git et appliquent automatiquement les modifications à l'infrastructure ou aux applications. Cela conduit à une automatisation élevée et à une réduction des erreurs manuelles.
3. Consistance et reproductibilité : Comme tout est défini en code et stocké dans Git, il est facile de reproduire l'infrastructure et les applications dans différents environnements. Cela aide à maintenir la consistance et facilite les tests et les déploiements.
4. Recouvrabilité : En cas de problème, il est facile de revenir à un état précédent de l'infrastructure ou des applications en utilisant Git. Cela améliore la recouvrabilité et réduit le temps de rétablissement en cas d'incident.
5. Sécurité et conformité : Toutes les modifications sont enregistrées dans Git, ce qui fournit un audit trail complet de qui a fait quoi et quand. Cela peut aider à répondre aux exigences de sécurité et de conformité.

Webhook et outils Nocode ?

Tout ça fait rêver mais comment ça se passe dans les faits ?

Depuis des années, ces outils ont été sollicités purement et difficilement par du code. La data est devenue si importante pour les entreprises que le python est aujourd’hui devenu le langage le plus populaire des développeurs. C’est aujourd’hui le langage que les data engineers utilisent pour faire des requêtes et interroger les outils, récupérer des données et automatiser les processus.

Mais heureusement, les outils Nocode et low-code se sont vite mis à la page pour proposer aux utilisateurs une méthode beaucoup plus accessible pour obtenir les mêmes résultats.

On peut prendre l’exemple de Zapier, Make (ex-Integromat) ou encore n8n, la solution d’automatisation open source - qui offre des modules de webhook.