Doc produitsMenu

Création d’un webhook JIRA

Le webhook transfère les notifications de toute modification dans le contenu de JIRA, ce qui permet au connecteur d’indexer des éléments nouveaux, modifiés ou supprimés. La procédure suivante résume les étapes nécessaires au déploiement de webhooks JIRA dans le serveur JIRA (voir Managing Webhooks et JIRA Webhooks Overview).

Pour créer un webhook JIRA

  1. Connectez-vous à votre instance de JIRA à l’aide d’un compte détenant la permission globale JIRA Administrator (voir Managing Global Permissions).

  2. Accédez à la page Webhooks :

    1. Dans le menu du haut à droite, dans la liste déroulante de la roue , sélectionnez System.

    2. Dans la boîte Administrator Access, tapez votre mot de passe, puis cliquez sur Confirm.

    3. Dans la page Settings du système, dans la barre de navigation à gauche, sous Advanced, sélectionnez Webhooks.

  3. Dans la page Webhooks, cliquez sur l'icône Create a Webhook.

  4. Créez le webhook à l’aide des paramètres et valeurs par défaut affichés dans le tableau suivant :

  5. Nom du paramètre Valeur
    Name Nom significatif de votre choix (ex., JIRA Webhook)
    URL

    http://[YourCoveoMasterServer]/jira/CoveoCrawler/JiraWebHook

    Important : Une fois que vous activez le webhook, il envoie des données chaque fois qu’un événement se produit dans JIRA. Si vous utilisez un webhook HTTP non-sécurisé, sachez qu’il peut exposer des informations potentiellement confidentielles. Il est donc fortement recommandé de définir un webhook HTTPS (voir HTTPS webhook).

    Note : CES 7.0.7183+ (novembre 2014) Soutien de la configuration d'un webhook HTTPS.

    Exclude details Vide
    Events Tous les événements de problème

    Important : Si Exclude details est coché, vos permissions JIRA ne seront pas mises à jour. Laissez la case décochée.

  6. Appuyez sur Créer (Create).

  7. Notes :

    • Par défaut, la fonction de surveillance en direct écoute dans le point de terminaison http://[YourCoveoMasterServer]/jira/CoveoCrawler/JiraWebHook du service web.

      Important : Une fois que vous activez le webhook, il envoie des données chaque fois qu’un événement se produit dans JIRA. Si vous utilisez un webhook HTTP non-sécurisé, sachez qu’il peut exposer des informations potentiellement confidentielles. Il est donc fortement recommandé de définir un webhook HTTPS (voir HTTPS webhook).

      Note : Définir un webhook HTTPS est possible à partir de CES 7.0.7183 (novembre 2014).

    • Si vous avez plus d’une source JIRA V2, créez un webhook pour chacune de vos sources JIRA V2 en utilisant le paramètre caché WebServiceEndpointName pour remplacer le nom du point de terminaison du service web (partie CoveoCrawler) dans l’URL par défaut du point de terminaison du service web (http://CoveoMasterServer/jira/CoveoCrawler/JiraWebHook).

      Exemple : Lorsque la valeur WebServiceEndpointName du paramètre caché est modifiée à CoveoCrawler1, l’URL du point de terminaison du service web devient http://CoveoMasterServer/jira/CoveoCrawler1/JiraWebHook. Vous pouvez alors créer un autre webhook à l’aide de cet URL.

    • Par défaut, la surveillance en direct est activée dans une source JIRA V2. Si vous désactivez la surveillance en direct, votre source ne sera pas mise à jour à l’extérieur des actualisations complètes (voir Changement de la surveillance en temps réel pour une source) .

    • CES 7.0.7183+ (novembre 2014) Vous pouvez définir le point de terminaison sécurisé et exposé pour utiliser une connexion https entre le webhook JIRA et le point de terminaison du robot.

      • Dans une installation régulière :

        1. Définissez le paramètre WebServiceEndpointUseHttps à true (voir Modification de paramètres de source cachés d'Atlassian JIRA V2).

        2. Configurez le port 443 avec le certificat ssl. Vous pouvez utiliser la commande netsh http add sslcert ipport=0.0.0.0:443 certhash=[tumbprint] appid={[crawler appid]} (voir How to: Configure a Port with an SSL Certificate).

      • Lorsque vous utilisez le certificat auto-signé, vous devez l’exporter dans Base64 à partir de l’ordinateur où le serveur maître de Coveo se trouve et ajoutez-le dans le Java KeyStore de JIRA :

        • Dans l’ordinateur où le serveur maître de Coveo est installé :

          1. Ouvrez le gestionnaire Internet Information Services (IIS).

          2. Sous Connections, cliquez sur le nom du serveur, puis sur Server Certificates.

          3. Sélectionnez le bon certificat, puis sous Actions, sélectionnez View.

          4. Dans l'onglet Details, cliquez sur Copy to File.

          5. Dans la fenêtre Welcome to the Certificate Export Wizard, lisez, puis cliquez sur Next.

          6. Dans la fenêtre Export Private Key, cochez No, do not export the private key, puis cliquez sur Next.

          7. Dans la fenêtre Export File Format, cochez Base-64 encoded X.509 (.CER), puis cliquez sur Next.

          8. Dans la fenêtre File to Export, dans la boîte File Name, entrez le nom du certificat que vous souhaitez exporter.

            Par défaut, le fichier est enregistré dans le dossier C:\windows\system32\.

          9. Dans la fenêtre Completing the Certificate Export Wizard, cliquez sur Finish.

        • Dans l’ordinateur JIRA :

          1. Ouvrez Command Prompt.

          2. Exécutez la commande suivante pour importer le certificat dans Java KeyStore :

            %JAVA_HOME%\bin\keytool -import -alias jira_tomcat -file [Your_Certificate_Path].CER -keystore %JAVA_HOME%\jre\lib\security\cacerts

          3. Entrez changeit, le mot de passe par défaut de Java TrustStore, lorsqu’on vous demande un mot de passe.

        Si vous essayez d’installer un webhook HTTPS avec un certificat auto-signé et avez rencontré des problèmes, référez-vous à la documentation de JIRA (voir SSLHandshakeException - unable to find valid certification path to requested target).

Prochaines étapes?

Dans votre serveur JIRA, installez le plug-in de Coveo afin de pouvoir indexer des permissions de sécurité JIRA (voir Installation du plug-in Coveo pour Atlassian JIRA).