Configurer les Webhooks (Configure Webhooks)

Les Webhooks fournissent des données à d'autres applications déclenchées par certaines alertes via HTTP POST. Chaque fois qu'une alerte se produit, la source envoie une demande HTTP à l'application cible configurée pour le Webhook. SD-WAN Orchestrator prend en charge les Webhooks qui envoient automatiquement des messages via HTTP POST aux applications cibles lorsqu'un événement se produit. Vous pouvez définir l'URL cible dans le portail d'entreprise et automatiser les actions en réponse aux alertes déclenchées par SD-WAN Orchestrator. Les destinataires Webhook doivent prendre en charge HTTPS et disposer de certificats valides pour garantir la confidentialité des charges utiles d'alertes potentiellement sensibles. Cela empêche également la falsification des charges utiles.

La page Webhooks de la fenêtre Configuration des alertes (Alert Configuration) permet de configurer les informations suivantes :


Option	Description
URL	Entrez une URL HTTPS valide. Cette URL sert d'application cible pour les Webhooks.
Code	Entrez un code d'état de réponse HTTP attendu pour chaque destinataire Webhook. Par défaut, SD-WAN Orchestrator s'attend à ce que les destinataires Webhook répondent aux demandes HTTP POST avec un code d'état HTTP 200. Lorsque SD-WAN Orchestrator reçoit un code d'état inattendu d'un serveur de destinataire ou d'un serveur proxy, il considère que la remise d'alerte a échoué et génère un événement client `ALERT_DELIVERY_FAILED`. Cet événement permet d'identifier le moment où un serveur de destinataire Webhook peut ne pas fonctionner comme prévu.
Secret	Spécifiez un jeton secret pour chaque destinataire Webhook configuré, qui est utilisé pour calculer un HMAC pour chaque demande Webhook envoyée au destinataire correspondant. Le HMAC est intégré dans un en-tête HTTP `X-Webhook-Signature`, avec un paramètre de version qui identifie l'algorithme de signature et un horodatage. X-Webhook-Signature: v=<signature-version>&t=<timestamp>&s=<hmac> Le destinataire interprète les composants comme suit : `v` : version de l'algorithme utilisée pour générer la signature. La seule valeur prise en charge est 1. `t` : horodatage d'époque de précision en millisecondes correspondant à l'heure à laquelle la demande est émise. `s` : HMAC calculé par SD-WAN Orchestrator. Le HMAC est calculé comme suit : `HMAC-SHA256(request-body + '.' + timestamp, secret)`. Le message utilisé pour calculer le HMAC est formé par la concaténation du corps de la demande, d'une période unique et de la valeur du paramètre d'horodatage qui s'affiche dans l'en-tête de la signature. L'algorithme HMAC spécifique utilisé pour générer le code est HMAC-SHA256. Après la réception d'une demande Webhook, le serveur d'écoute peut vérifier l'authenticité de la demande en calculant sa propre signature HMAC-SHA256 en fonction du même algorithme et en comparant la signature nouvellement calculée avec celle générée par SD-WAN Orchestrator.
Modèle de charge utile JSON (JSON Payload Template)	Ce champ est obligatoire. SD-WAN Orchestrator fournit des notifications d'alerte à chaque destinataire Webhook, via une charge utile JSON contenue dans le corps d'une demande HTTP POST sortante. SD-WAN Orchestrator génère le contenu de la charge utile de manière dynamique, car les notifications sont envoyées en effectuant une interpolation variable. Les variables d'espaces réservés prises en charge dans le modèle de charge utile configurée par l'utilisateur sont remplacées par des valeurs propres aux alertes.
Vérifier (Verify)	Cliquez sur cette option pour valider les informations entrées.

Cliquez sur le lien Configurer le modèle de charge utile (Configure Payload Template) dans l'option Modèle de charge utile JSON (JSON Payload Template) pour configurer les éléments suivants :


Option	Description
Heure de l'alerte (Alert Time)	Entrez la date et l'heure de déclenchement de l'alerte.
Type d'alerte (Alert Type)	Sélectionnez le type d'alerte dans le menu déroulant. Par défaut, elle indique S/O (N/A).
ID logique du client (Customer Logical ID)	Entrez l'ID logique du client auquel la notification doit être envoyée.
Client (Customer)	Entrez le nom du client auquel la notification doit être envoyée.
ID logique du périphérique (Device Logical ID)	Entrez l'ID logique du dispositif Edge auquel l'alerte doit être appliquée.
Description du périphérique (Device Description)	Entrez un bref message décrivant le dispositif Edge auquel l'alerte doit être appliquée.
Numéro de série du périphérique (Device Serial Number)	Entrez le numéro de série du dispositif Edge auquel l'alerte doit être appliquée.
Nom du périphérique (Device Name)	Entrez le nom du dispositif Edge auquel l'alerte doit être appliquée.
Dernier contact (Last Contact)	Entrez la date et l'heure à laquelle le dispositif Edge concerné a communiqué le plus récemment avec SD-WAN Orchestrator. Cela s'applique uniquement aux alertes Edge.
VCO	Entrez le nom d'hôte ou l'adresse IP publique de SD-WAN Orchestrator d'où la notification doit être envoyée.
Message	Entrez un bref message décrivant l'événement qui doit déclencher l'alerte.
Entité affectée (Entity Affected)	Entrez le nom de l'entité : dispositif Edge ou lien voire VNF auquel l'alerte doit être appliquée.

L'exemple suivant montre un exemple de modèle de charge utile JSON :

{
   "alertTime": "alertTime",
   "alertType": "alertType",      
   "customer": "customer",
   "customerLogicalId": "customerLogicalId",
   "entityAffected": "entityAffected",
   "deviceLogicalId": "deviceLogicalId",
   "lastContact": "lastContact",
   "message": "message",
   "vco": "vco",
   "deviceName": "deviceName",
   "deviceDescription": "deviceDescription",
   "deviceSerialNumber": "deviceSerialNumber"
}

Cliquez sur Enregistrer (Save), puis cliquez sur Save Changes (Enregistrer les modifications) sur la page Webhooks pour enregistrer les configurations des Webhooks.

Chaque fois qu'une alerte est déclenchée, un message d'alerte ainsi que des informations pertinentes sont envoyés à l'URL cible.