Passer au contenu principal
Version : 8.6.0

Comment créer un Webhook ?

Ce guide explique étape par étape comment créer un Webhook dans KentixONE. Vous apprendrez quels champs existent, dans quel cas chaque option est pertinente et comment envoyer des données de test. Une référence des variables disponibles se trouve en bas de page.

Prérequis

  • Accès à l'interface web KentixONE avec des droits administrateur
  • Endpoint cible (URL) du service externe qui doit recevoir la demande
  • Facultatif : Identifiants pour une authentification Basic-Auth ou un token Bearer si votre endpoint nécessite une authentification

Vue d'ensemble

  • Un Webhook est une requête HTTP envoyée par KentixONE à une URL que vous définissez lorsqu'un événement survient (par ex. : alarme, action utilisateur).
  • Vous choisissez la méthode (GET/POST/PUT/PATCH/DELETE), le type de contenu et le contenu exact des données (Payload).
  • Les variables, comme des valeurs d'alarme ou d'utilisateur, peuvent être insérées dans les données. Ces variables sont automatiquement remplacées par KentixONE lors du déclenchement.

Guide pas à pas

1. Ouvrir l'aperçu des Webhooks

  • Naviguez vers : Automatisation → Webhooks.
  • Dans le tableau, vous trouverez les entrées existantes et vous pourrez ajouter de nouveaux Webhooks.

2. Ajouter un nouveau Webhook

  • Cliquez sur « Ajouter un Webhook ».
  • Activer : Activez le Webhook s'il doit être utilisable immédiatement.
  • Nom : Donnez un nom explicite.
  • URL : Entrez l'Endpoint cible complet (https://…)

3. Choisir la méthode HTTP

  • Sélectionnez la méthode souhaitée.
  • Les options disponibles sont POST, GET, PUT, PATCH, DELETE.
Note

L'envoi de données utilise généralement une requête POST.

4. Configurer l'authentification (facultatif)

  • Pas d'authentification : Pour les endpoints librement accessibles.
  • Basic Auth : KentixONE envoie le nom d'utilisateur/mot de passe dans l'en-tête Authorization (Base64).
  • Bearer Token : KentixONE envoie le token dans l'en-tête Authorization.
Info

La SmartAPI KentixONE utilise l'authentification Bearer Token.

5. Définir le type de contenu

  • Les types pris en charge sont text/plain, application/json ou application/xml.
  • Sélectionnez le type correspondant au système cible.
Info

Pour la SmartAPI KentixONE, choisissez le type de contenu application/json.

6. Définir les données utiles (Payload)

Ajoutez le corps des données en fonction du type de contenu. Exemple pour JSON :