Qu'est-ce qu'un webhook?

Un webhook est une requête HTTP définie par l'utilisateur qui est envoyée depuis un site source vers une URL unique d'une application lorsqu'un événement particulier a lieu. Les webhooks permettent aux applications de communiquer entre elles et de faciliter les opérations de manière rapide et efficace.

Alors que les API permettent également la communication entre les applications, une différence majeure entre les deux réside dans leur fonctionnement.

Avec les API, vous devez interroger chaque fois que vous souhaitez obtenir des informations de l'application; Les webhooks, quant à eux, sont automatisés et vous avertissent chaque fois qu'un événement particulier se produit dans votre application.

Intégration de Webhook avec OpManager de ManageEngine

En intégrant des webhooks dans OpManager, vous pouvez envoyer des données à une URL de webhook spécifiée appartenant à une application tierce. Par exemple, les webhooks permettent d'intégrer OpManager avec Microsoft Teams et Telegram.

Avec les webhooks, OpManager envoie les détails de l'alarme à une URL particulière de l'application tierce concernée. Le propriétaire de l'application prendrait alors les mesures appropriées en fonction du contenu des données envoyées.

Collaboration inter-applications via des webhooks

Un aspect utile de l'intégration de webhook est qu'elle permet aux applications d'échanger des informations sans effort lorsque des événements spécifiques se produisent. La collaboration avec d'autres applications est cruciale pour une solution de surveillance réseau comme OpManager afin de réduire les temps d'arrêt, d'améliorer les performances et de résoudre rapidement les pannes.

OpManager surveille en permanence le réseau pour les performances, la disponibilité et l'identification des pannes. Les webhooks permettent à OpManager d'envoyer des informations à des applications telles que ServiceDesk Plus, ServiceNow, Slack, etc. en tirant parti de ses capacités de surveillance réseau.

Ainsi, chaque fois que certains événements (dépassements de seuil) se produisent, les détails des alarmes sont automatiquement envoyés aux applications spécifiées immédiatement.

Webhooks utilisés en temps réel

Les détails de l'alarme envoyés depuis OpManager sont convertis dans des formulaires appropriés en fonction de l'application dans laquelle les données sont utilisées.

Webhook integration with OpManager - ManageEngine OpManager

Disons qu'OpManager localise une défaillance matérielle qui nécessite un remplacement immédiat. Les webhooks entrent en jeu ici, et une fois que cet événement - défaillance de l'appareil - se produit, l'alarme déclenchée pour ce problème sera transmise à ServiceDesk Plus sous forme de ticket.

Disons qu'OpManager localise une défaillance matérielle qui nécessite un remplacement immédiat. Les webhooks entrent en jeu ici, et une fois que cet événement - défaillance de l'appareil - se produit, l'alarme déclenchée pour ce problème sera transmise à ServiceDesk Plus sous forme de ticket.

En revanche, si ce détail d'alarme est remonté vers Slack, les détails d'alarme seront convertis en message et apparaîtront sur le canal de communication utilisé.

Avant tout, l'intégration webhook-OpManager tire parti de la gestion de votre infrastructure informatique et offre les avantages suivants:

  • Simplifie le travail des administrateurs informatiques avec des alertes en temps réel.
  • Intègre OpManager avec une large gamme d'applications tierces
  • Atténue la latence dans la communication avec les applications.
  • Donne plus de contrôle en envoyant uniquement les informations pertinentes spécifiées aux applications

Webhooks dans OpManager: comment cela fonctionne

OpManager envoie les données d'alarme à une URL particulière en tant que requête HTTP une fois que l'événement souhaité a eu lieu. En réponse, l'application enverra un rappel HTTP à OpManager. Vous devez obtenir l'URL du webhook de l'application à laquelle les données sont envoyées.

Les types de contenu des requêtes HTTP pris en charge dans OpManager sont:

  • Texte non ASCII
  • Grandes données binaires
  • Texte simple, données ASCII ou texte
  • XML
  • JSON
  • Javascript et HTML

Après chaque requête HTTP réussie, un code de réponse de réussite sera ajouté dans les journaux d'OpManager. De même, pour chaque exécution échouée, un code de réponse d'échec sera ajouté dans les journaux.

Vous pouvez également définir la durée du délai d'expiration, qui est la durée pendant laquelle OpManager attendra une réponse de l'application. Cela garantit une réponse rapide et opportune de l'application.

Types de méthode d'URL de webhook

Vous pouvez spécifier le type de demande adressée à l'application tierce. Les types de méthode d'URL de webhook pris en charge par OpManager sont:

  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
  • HEAD

Comment configurer les webhooks dans OpManager

Étape 1:

  • Accédez à Paramètres> Notifications> Ajouter un profil dans OpManager.
  • Cliquez sur Invoquer un Webhook.

Étape 2:

  • Choisissez le type de méthode Hook URL (par exemple: GET) dans la liste déroulante. Lorsque vous choisissez un type de méthode autre que GET, vous devrez spécifier certains autres paramètres. Voir l'étape 3 ci-dessous pour plus de détails.
  • Saisissez l'URL du hook de l'application.

Étape 3: Applicable uniquement si le type de méthode Hook URL n'est pas GET

  • Type de données: choisissez un type parmi les trois catégories données: form-data, form url-encoded ou raw.
  • Pour les données de formulaire ou le formulaire encodé par URL, ajoutez les paramètres personnalisés selon votre priorité et entrez les valeurs appropriées dans les zones adjacentes.
  • Pour le type de données raw, mentionnez ce qui suit:
    • Entrez le type de charge utile.
    • Fournissez une description du message dans le contenu du corps.

Étape 4:

  • Spécifiez le type de contenu dans les en-têtes de demande.
  • Spécifiez l'agent utilisateur si nécessaire.
  • Entrez la valeur de Time Out (en secondes).

Remarque: la chaîne d'agent utilisateur (UA) d'un navigateur permet d'identifier le navigateur utilisé, sa version et le système d'exploitation sur lequel il est utilisé.

Étape 5:

  • Enfin, cliquez sur Suivant.

En général, les champs obligatoires à mentionner lors de la configuration des Webhooks sont:

  1. Le type de méthode de l'URL du hook.
  2. L'URL Hook de l'application.
  3. La durée du time-out.
  4. Le type de contenu sous les en-têtes de demande.
  5. Le type de charge utile et le contenu du corps (si le type de données brutes est choisi).

Utilisation de paramètres personnalisés pour les webhooks

Vous pouvez ajouter un certain nombre de variables d'alarme et les champs personnalisés comme l' adresse IP, le type de périphérique, gravité, Localisation, Détails de contact, et plus, de sorte que chaque fois qu'un événement se produit, ces détails seront envoyés comme paramètre  à l'URL de webhook spécifié.

Integrate Webhook with OpManager - ManageEngine OpManager

Le message qui sera partagé avec l'URL du webhook dans le cas ci-dessus est représenté ci-dessous:

https://hooks.app.com/data/sample?ipaddress=$DeviceField(ipAddress)&devicetype=$DeviceField(type)&severity=$stringseverity

To: hooks.app.com/data/sample
IP Address: $DeviceField(ipAddress)
Device Type: $DeviceField(type)
Severity: $stringseverity

Remarque : des variables proxy ont été utilisées dans l'exemple ci-dessus. Les valeurs réelles seront mises à jour pour les variables lorsque le webhook est appelé depuis OpManager.

Utilisation de types de données brutes dans les webhooks

Contrairement aux types de données form-data et form-urlencoded, le choix du type de données brutes vous donne la liberté d'ajouter un message brut non limité par aucun paramètre.

Webhook OpManager integration - ManageEngine OpManager