For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhooks

Comment configurer les webhooks dans VergeOS pour la messagerie push vers des systèmes externes, y compris la création de webhooks, la configuration de la charge utile des tâches et la configuration des déclencheurs d’événements.

Les webhooks permettent l’envoi de messages en mode push vers des systèmes externes lorsque des événements spécifiques se produisent. Lorsqu’un événement déclencheur a lieu, un webhook envoie une requête HTTP (généralement un POST) vers une URL prédéfinie. Ce mécanisme push est plus efficace que l’interrogation périodique, tant pour les notifications que pour l’automatisation des workflows, car le système récepteur n’a pas besoin de vérifier régulièrement les mises à jour.

Exemples d’utilisation des webhooks

Les webhooks VergeOS offrent une grande configurabilité pour la communication pilotée par événements avec des systèmes tiers, offrant un large éventail de possibilités de simplification. Les exemples de base suivants illustrent des alertes possibles et l’automatisation de workflows à l’aide de webhooks :

  • Envoyer une notification Slack à un canal d’administration lorsqu’un travail de synchronisation produit une erreur

  • Publier dans un système comptable lorsqu’un locataire VergeOS se met en ligne, déclenchant ainsi une facturation automatique

  • Déclencher un workflow Zapier lorsqu’une machine virtuelle spécifique démarre, initiant des actions interapplications (par ex. rapports, e-mails, notifications, etc.)

Étapes de configuration

Pour mettre un webhook en action, suivez ces étapes :

  • Créer un webhook: définit l’URL cible, la méthode d’authentification et tous les en-têtes personnalisés requis par le système externe

  • Créer une tâche: définit la charge utile à livrer

  • Créer un événement: désigne une occurrence qui activera la tâche

Créer un webhook

  1. Accédez à Système > Tableau de bord des tâches.

  2. Cliquez sur Nouveau webhook dans le menu de gauche.

  3. Configurer le webhook :

  • Nom: Fournissez un nom descriptif pour le webhook.

  • URL: Saisissez le point de terminaison API exposé par le système concerné pour accepter les requêtes HTTP POST.

Par défaut, un en-tête est inclus pour spécifier une charge utile content-type: application/json. Cet en-tête peut être supprimé ou modifié selon les besoins, et des en-têtes supplémentaires peuvent être configurés si nécessaire ou pris en charge par le système cible (par ex. modifier le type de contenu, le routage des événements, la limitation de débit, la priorité, etc.) - Pour modifier l’ordre des en-têtes personnalisés : sélectionnez la case à cocher de l’en-tête ou des en-têtes souhaités et utilisez les boutons fléchés Haut/Bas - Utilisez le bouton Plus pour ajouter des en-têtes supplémentaires - Le bouton crayon bascule entre la saisie par paire clé/valeur d’en-tête et la saisie manuelle de la syntaxe complète de l’en-tête

  • Autoriser les certificats non sécurisés: Cette option est destinée à prendre en charge les certificats auto-signés pour les environnements de test/développement. L’utilisation de certificats non sécurisés pour les systèmes et données de production (en particulier les URL publiques) est risquée et déconseillée.

  • Délai d’attente dépassé: Définit le nombre maximal de secondes à attendre une réponse du système cible (doit être de 3 ou plus)

  • Réessais: Nombre de nouvelles tentatives à effectuer lorsqu’aucune réponse ou qu’une erreur est renvoyée par le système cible

  1. Cliquez sur Soumettre pour enregistrer le webhook.

Créer une tâche

  1. Accédez à Système > Tableau de bord des tâches.

  2. Cliquez sur Nouvelle tâche dans le menu de gauche.

  3. Configurer la tâche :

    • Nom: Fournissez un nom descriptif pour la tâche.

    • Description (facultatif): Des informations supplémentaires peuvent être stockées pour la tâche, par ex. son objectif, le résultat attendu, etc.

    • Supprimer la tâche après exécution: définit une activation unique ; le système supprimera automatiquement la tâche après sa première exécution.

    • Type d'objet: Webhook

    • Objet : Sélectionnez le webhook créé à l’étape précédente.

    • Action: Envoyer

    • Message: Définissez la charge utile à envoyer au système externe. - La charge utile par défaut inclut une paire clé-valeur de base avec la chaîne « Webhook » comme valeur ; supprimez-la ou modifiez-la selon les besoins pour créer la charge utile souhaitée.

  1. Cliquez sur Soumettre pour enregistrer la tâche.

Créer un événement

  1. Accédez à Système > Tableau de bord des tâches.

  2. Cliquez sur Nouvel événement dans le menu de gauche.

  3. Configurer l’événement :

    • Type: Sélectionnez la zone applicable du système VergeOS où le déclencheur se produira.

    • Événement: La liste des événements changera en fonction du type sélectionné ci-dessus. Sélectionnez l’événement souhaité qui servira de déclencheur.

    • Sélectionner une instance d’objet spécifique ou une balise pour déclencher l’événement : (certains types sélectionnés, tels que Alarmes s’appliquent à un niveau générique et ne proposent pas d’options pour les balises ou les objets spécifiques.)

      • Sélectionnez une instance spécifique du type d’objet dans la liste déroulante (Par exemple, « Users » est le type sélectionné - choisissez un utilisateur particulier dans le Utilisateur liste déroulante ; le type sélectionné est « Virtual Machines » - choisissez une VM particulière dans la Machines virtuelles liste déroulante.)

      OU

      • Activez le Utiliser l'étiquette et sélectionnez une étiquette disponible dans la liste déroulante pour baser l'événement sur les objets portant cette étiquette correspondante. (Par exemple, si « Virtual Machines » est le type sélectionné et que « production » est sélectionné dans la Étiquette liste déroulante, le déclencheur d'événement correspond à toutes les VM auxquelles l'étiquette « production » est attribuée.)

    • Tâche: Sélectionnez la tâche créée à l’étape précédente.

  4. Cliquez sur Soumettre pour enregistrer l’événement.


Compatibilité de version: Cette fonctionnalité est disponible dans VergeOS 26.0 et versions ultérieures.

Mis à jour

Ce contenu vous a-t-il été utile ?