Plugin Webhook pour Ticket Orchestrator

Ce document explique comment configurer l'intégration Webhook ITSM avec le module Ticket Orchestrator de la plateforme Netskope Cloud Exchange. Ce plugin est utilisé pour créer un Webhook sur une plateforme qui supporte Webhook. Ce plugin utilise uniquement la méthode POST.

Conditions préalables

Pour compléter cette configuration, vous avez besoin de :

Champ d'application du plugin

Ce plugin permet de créer des notifications pour les alertes Netskope.

Prise en charge du plugin Webhook

Mises en correspondance

NA

Permissions

Permission d'envoyer des données à l'URL Webhook.

Matrice de performance

Cette lecture de performance a été considérée après avoir laissé le plugin fonctionner pendant quelques heures et pris des lectures aléatoires par minute pour collecter le compte moyen pour le nombre de tickets qui sont générés dans Webhook. Les relevés sont collectés sur une grande pile CE avec les spécifications ci-dessous.

Détails de l'API

Le plugin utilise l'URL du Webhook pour exécuter la transmission de données via une requête POST dirigée vers l'URL fournie.

Liste des API utilisées

Créer un ticket

Example

API Endpoint

<URL of your Webhook>

Method

POST

Parameters

None

Data

{"text": "This is a new message.", "unflur_link": true}

API Request Endpoint

<URL of your Webhook>

https://hooks.slack.com/services/T69KXV56W/B05SXH8JTSA/xYE9SZvmwHZh6l4gaL*****C

Sample API Response

Agent utilisateur

L'agent utilisateur ajouté pour ce plugin est au format suivant :

netskope-ce-<CE VERSION>-<MODULE NAME>-<PLUGIN NAME>-v<PLUGIN VERSION> 

qui sera :

netskope-ce-4.2.0-cto-webhook-v1.0.0

Workflow

1. Obtenir l'URL d'un Webhook.
2. Configurez le plugin Webhook.
3. Créez une règle métier Ticket Orchestrator pour le Webhook.
4. Créez une file d'attente Ticket Orchestrator pour le Webhook.
5. Validez sur la section des billets.
6. Validez sur l'application Webhook (comme Chat).

Cliquer sur « play » pour regarder une vidéo.

Obtenir l'URL d'un Webhook

1. Pour créer une URL Webhook, rendez-vous sur Google Chat > Spaces.
2. Cliquez Space Name.
   
3. Cliquez sur Apps & integrations.
4. Cliquez sur Add webhooks.
5. Entrez un Name pour votre Webhook et cliquez sur Save.
6. Cliquez sur les trois points et Copy Link, puis enregistrez l'URL dans un emplacement sécurisé. Vous en aurez besoin pour configurer le plugin Webhook.

Configurer le plugin Webhook

1. Aller à Settings > Plugins. 
2. Recherchez et sélectionnez le plugin Webhook . (assurez-vous que le module Ticket Orchestrator est activé. Si ce n'est pas le cas, allez sur Settings > General et activez le module Ticket Orchestrator).
3. Saisir un nom de configuration.
4. Réglez l'intervalle de synchronisation sur la valeur appropriée : La valeur suggérée est de 5+ minutes.
5. Cliquez sur Next.
6. Saisissez l'URL de votre WebHook. Il aura le format suivant : https://chat.googleapis.com/v1?/*****.
7. Cliquez sur Save.

Créer une règle de gestion Ticket Orchestrator pour le Webhook

Créez une règle de gestion basée sur les filtres dont vous avez besoin pour générer des tickets dans le plugin Webhook.

1. Sous le module Ticket Orchestrator , sélectionnez Business Rules.
2. Cliquez sur Create new rule.
3. Entrez le nom de règle approprié dans la boîte de texte et construisez la condition de requête de filtre appropriée sur le(s) champ(s) de la règle métier. Vous pouvez également taper la requête manuellement en cliquant sur Filter Query.
4. Cliquez sur Save.
5. Pour tester la nouvelle règle métier créée, cliquez sur le icône et entrez le Time period (in days), puis cliquez sur Fetch. Ceci affichera le nombre d'alertes éligibles à la création d'un incident/ticket.

Créer une file d'attente Ticket Orchestrator pour le Webhook

1. 1. Dans Ticket Orchestrator, cliquez sur Queues.
   2. Cliquez sur Add Queue Configuration.
   3. Select le site Business Rule précédemment créé dans la liste déroulante.
   4. Select le plugin Configuration de la liste déroulante pour laquelle la file d'attente est configurée.
   5. Select le site Queues dans la liste déroulante qui contiendra la notification. La notification sera créée dans le webhook sélectionné.
   6. Ajoutez/mettez en correspondance les valeurs appropriées entre les alertes et les incidents dans la section Map Field. Les attributs de l'alerte sont accessibles via $ dans le champ du message personnalisé.

1. Cliquez sur Save.
2. Conformément aux règles métier, des notifications Webhook seront automatiquement créées pour les alertes entrantes. Pour créer des notifications Webhook pour les alertes historiques, cliquez sur sur la file d'attente configurée et entrez la période (en jours), puis cliquez sur Fetch. Ceci affichera le nombre d'alertes pouvant faire l'objet d'une création de ticket. Cliquez sur Sync pour créer des données Webhook pour ces alertes.

Valider le plugin Webhook

Valider dans Cloud Exchange

Pour valider le site workflow, vous devez avoir Netskope Alertes.

1. Pour afficher la liste des tickets créés sur Webhook, allez à Tickets sous le menu Ticket Orchestrator .
2. Si les tickets ne sont pas créés sur Webhook, vous pouvez consulter les journaux d'audit dans Cloud Exchange > Logging. Appliquez le filtre : "Tapez n'importe quoi dans Erreur.

Valider sur la plateforme supportant les webhooks

Accédez à la plateforme Webhook URL (dans notre cas, le groupe de discussion Google).

Dépannage du plugin Webhook

Impossible de créer une notification à l'aide du plugin

Si vous n'êtes pas en mesure de partager des notifications à partir du plugin, cela peut être dû à l'une des raisons suivantes :

• Si vous n'êtes pas en mesure d'envoyer des données à l'URL Webhook, veuillez vérifier si les alertes New ont été récupérées ou non.

What to do: Si vous rencontrez le problème ci-dessus, cela peut être dû au point susmentionné. Pour résoudre ce problème, suivez les étapes suivantes :

• Si vous n'êtes pas en mesure d'envoyer des données à l'URL Webhook.
  1. Allez sur Netskope CE.
  2. Cliquez sur Ticket Orchestrator.
  3. Cliquez sur Alertes.
  4. Vérifiez si les alertes New sont présentes ou non.

Limitation du plugin Webhook

Une contrainte notable apparaît lors de la conversion des données en JSON. Si le champ de description dans la conversion JSON contient des guillemets doubles, il en résulte une erreur due à la présence de champs dynamiques contenant des guillemets doubles, ce qui rend l'objet JSON invalide.