Un premier aperçu des Webhooks (v2)

ATTENTION : Notez que cette fonctionnalité ou cet article est destiné aux utilisateurs avancés.

Un webhook est un moyen pour une application ou un logiciel comme Ultimate Multisite de fournir à d'autres applications des informations en temps réel. Un webhook transmet des données ou des charges utiles aux autres applications au fur et à mesure, ce qui signifie que vous recevez les données immédiatement.

Ceci est utile si vous avez besoin d'intégrer ou de transmettre certaines données d'Ultimate Multisite vers un autre CRM ou système chaque fois qu'un événement est déclenché. Par exemple, vous devez envoyer le nom et l'adresse e‑mail de l'utilisateur à une liste de diffusion chaque fois qu'un nouveau compte utilisateur est créé.

Comment créer un webhook

Pour créer un webhook, accédez à votre tableau de bord d'administration réseau. Cliquez sur Ultimate Multisite > Webhooks > Add New Webhook.

Lors de la création d'un nouveau webhook, on vous demandera des informations telles que Name, URL, et Event. Vous pouvez choisir n'importe quel nom pour votre webhook. Les champs les plus importants sont l'URL et l'Event.

URL est le point de terminaison ou la destination vers laquelle Ultimate Multisite enverra la charge utile ou les données. C'est l'application qui recevra les données.

Zapier est la solution la plus courante que les utilisateurs utilisent pour faciliter l'intégration avec une application tierce. Sans une plateforme comme Zapier, vous devrez créer manuellement une fonction personnalisée qui capturera les données et les traitera. Consultez cet article sur how to use Ultimate Multisite webhook with Zapier.

Dans cet article, nous allons examiner le concept de base du fonctionnement d'un webhook et les événements disponibles dans Ultimate Multisite. Nous utiliserons un site tiers appelé requestbin.com. Ce site nous permettra de créer un point de terminaison et de capturer la charge utile sans coder. Disclaimer : tout ce qu'il fera est de nous montrer que les données ont été reçues. Aucun traitement ni aucune action ne sera effectué sur la charge utile.

Allez sur requestbin.com et cliquez sur Create Request Bin.

Après avoir cliqué sur ce bouton, il vous demandera de vous connecter si vous avez déjà un compte ou de vous inscrire. Si vous avez déjà un compte, il vous dirigera directement vers leur tableau de bord. Sur leur tableau de bord, vous verrez immédiatement le point de terminaison ou l'URL que vous pouvez utiliser pour créer votre webhook Ultimate Multisite.

Copiez l'URL et revenez à Ultimate Multisite. Placez le point de terminaison dans le champ URL et sélectionnez un événement dans le menu déroulant. Dans cet exemple, nous sélectionnerons Payment Received.

Cet événement est déclenché chaque fois qu'un utilisateur effectue un paiement. Tous les événements disponibles, leurs descriptions et leurs charges utiles sont listés en bas de la page. Cliquez sur le bouton Add New Webhook pour enregistrer le webhook.

Nous pouvons maintenant envoyer un événement de test au point de terminaison afin de vérifier si le webhook que nous avons créé fonctionne. Nous pouvons le faire en cliquant sur Send Test Event sous le webhook que nous avons créé.

Cela affiche une fenêtre de confirmation indiquant que le test a réussi.

Maintenant, si nous retournons sur le site Requestbin, nous verrons que la charge utile a été reçue contenant quelques données de test.

Ceci est le principe de base du fonctionnement des webhooks et des points de terminaison. Si vous devez créer un point de terminaison personnalisé, vous devrez créer une fonction personnalisée pour traiter les données que vous recevez d'Ultimate Multisite.