Ce guide vous aidera à configurer une intégration de webhook pour envoyer des alertes de Dotcom-Monitor à vos tickets Jira. Dotcom-Monitor exploite la méthode de diffusion d’alertes HTTP Webhook pour connecter le système d’alerte Dotcom-Monitor et les tickets Jira via des requêtes webhook. Pour configurer l’intégration, assurez-vous de disposer des autorisations nécessaires pour créer des tickets dans votre projet Jira.

Configuration de l’intégration

Générer un jeton d’API Jira :

  1. Rendez-vous sur la page Authentification de base pour les API REST du portail Atlassian Developer pour savoir comment générer un jeton d’API et configurer l’authentification de base avec Jira.
  2. Enregistrez le jeton d’API généré pour l’utiliser dans l’en-tête d’autorisation dans Dotcom-Monitor.

Configurer le webhook dans dotcom-monitor

Lors de l’utilisation de requêtes API, en particulier avec des en-têtes d’authentification, JIRA nécessite parfois un en-tête supplémentaire pour contourner la protection CSRF. Pour résoudre ce problème, incluez l’en-tête X-Atlassian-Token avec la valeur no-check dans votre demande de webhook.

  1. Connectez-vous à votre compte Dotcom-Monitor et accédez à la configuration des groupes d’adresses de livraison (Gérer le > groupe d’adresses de livraison).
  2. Créez un nouveau groupe ou ouvrez-en un existant pour l’édition. Ajoutez Webhook comme adresse de livraison. Consultez l’article Intégration du webhook HTTP pour savoir comment envoyer des messages d’alerte Dotcom-Monitor à une URL de webhook dédiée.
  3. Dans le champ URL du webhook, saisissez : https://your-domain.atlassian.net/rest/api/3/issue
  4. Définissez le type de demande sur POST.
  5. Laissez la section Authentification vide.
  6. Dans la section En-têtes , ajoutez les en-têtes suivants. Assurez-vous d’encoder en BASE64 la chaîne useremail :api_token :
    • Autorisation : Basic [useremail:api_token]
    • Type de contenu : application/json
    • X-Atlassian-Token : no-check
  7. Dans le champ Payload , saisissez la structure de données JSON qui sera envoyée à Jira. Voici un exemple de charge utile : 
    @{
string _text = "";
foreach (var sessionResponse in Model.SessionResponses)
{
    foreach (var response in sessionResponse.Children)
    {
        _text += "Task Type: " + response.Task.TaskType_Name + ", " +
                 "Details Url: " + Model.DMUserLink + "/client/response-details/hit?id=" + response.ID + "&rootId=" + Model.RootResponse.ID + "&cuid=" + Model.OnlineReportCUID + ", " +
                 "View Task Url: " + Model.DMUserLink + "/v2/EditLegacyTask/" + response.Device.ID + "/" + response.Task.ID + ", " +
                 "Task Name: " + response.Name + ", " +
                 "Target: " + response.Target + ", ";

        if (response.AllErrors != null)
        {
            foreach (var error in response.AllErrors)
            {
                _text += error.ErrorType + " (" + error.ErrorCode + ") " + error.Reason;
            }
        }
    }
}
}
{
  "fields": {
    "project": {
      "key": "JIRA_PROJECT_KEY"
    },
    "summary": "Alert from Dotcom-Monitor",
    "description": {
      "type": "doc",
      "version": 1,
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "text":"@_text",
              "type": "text"
            }
          ]
        }
      ]
    },
    "issuetype": {
      "name": "Task"
    },
    "components": [
      {
        "name": "Default Component"
      }
    ]
  }
}
  8. Remplacez "PROJECT_KEY" par la clé de votre projet Jira.

Tester le Webhook

Une fois l’intégration du webhook configurée, nous vous recommandons de tester votre appareil de surveillance en envoyant une alerte de test :

  1. Dans la liste des appareils, passez la souris sur l’appareil de surveillance que vous souhaitez tester.
  2. Cliquez sur le menu Options (⋮) > Envoyer l’alerte > de test en panne.
  3. Vérifiez votre projet Jira pour voir si l’alerte a créé un nouveau ticket.

Utilisation de variables dynamiques dans le modèle d’alerte

Si vous devez inclure des variables dynamiques Dotcom-Monitor dans votre charge utile JSON, consultez l’article Ajout de variables dynamiques au modèle d’alerte . Si vous rencontrez des problèmes ou si vous avez des exigences spécifiques, veuillez contacter le support Dotcom-Monitor pour obtenir de l’aide.