Comment créer un Webhook ?
Ce guide explique étape par étape comment créer un Webhook dans KentixONE. Vous apprendrez quels champs sont disponibles, quand chaque option est utile et comment envoyer des données de test. Pour un aperçu des variables disponibles, voir la référence du Webhook ci-dessous.
Prérequis
- Accès à l'interface Web KentixONE avec des droits administratifs
- Endpoint cible (URL) du service externe qui doit recevoir la requête
- Facultatif : Identifiants pour Basic-Auth ou un Bearer Token, si votre endpoint nécessite une authentification
Vue d'ensemble
- Un Webhook est une requête HTTP que KentixONE envoie à une URL définie par vous lors d'un événement (par exemple, alarme, action utilisateur).
- Vous définissez la méthode (GET/POST/PUT/PATCH/DELETE), le type de contenu et le contenu précis des données (payload).
- Des variables comme les valeurs d'alarme ou d'utilisateur peuvent être insérées dans les données. KentixONE remplace automatiquement ces variables lors du déclenchement.
Instructions pas-à-pas
1. Ouvrir la vue d'ensemble des Webhooks
- Naviguez vers : Configuration → Webhooks.
- Dans le tableau, vous verrez les entrées existantes et pourrez créer de nouveaux Webhooks.
2. Créer un nouveau Webhook
- Cliquez sur « Créer un Webhook ».
- Actif : Activez le Webhook s'il doit être immédiatement opérationnel.
- Nom : Assignez un nom explicite.
- URL : Indiquez 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 est généralement effectué avec une requête POST.
4. Configurer l'authentification (facultatif)
- Pas d'authentification : Pour des endpoints librement accessibles.
- Basic Auth : KentixONE envoie un 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
L'API intelligente KentixONE utilise l'authentification par Bearer Token.
5. Définir le type de contenu
- Les types pris en charge sont
text/plain,application/jsonouapplication/xml. - Choisissez le type compatible avec le système cible.
Info
Pour l'API intelligente KentixONE, sélectionnez le type de contenu application/json.
6. Définir les données (Payload)
Ajoutez le corps des données en fonction du type de contenu choisi. Un exemple pour JSON :