Creating a Jira Software Webhook

The webhook pushes notifications for any change in Jira content, allowing the connector to immediately index new, modified, or deleted items. The following procedure outlines the steps needed to deploy Jira Software webhooks on the Jira Software server (see Managing Webhooks and Webhooks).

To create a Jira Software Webhook

1. Log in to your Jira instance using an account with the Jira Administrator global permission (see Managing Global Permissions).

2. Access the Webhooks page:

   1. In the top-right menu, in the gear drop-down list, select System.

   2. In the Administrator Access box, enter your password, and then click Confirm.

   3. In the system Settings page, in the navigation bar on the left, under Advanced, select Webhooks.

3. In the Webhooks page, click Create a Webhook icon.

4. Create the webhoook using the parameters and default values shown in the following table:

Parameter name	Value
Name	Significant name of your choice (e.g. Jira Software Webhook)
URL	http://[YourCoveoMasterServer]/jira/CoveoCrawler/JiraWebHook Important: Once you enable the webhook, it sends data each time an event occurred in Jira Software. If you use an unsecured HTTP webhook, be aware that it can expose potentially sensitive information. It is thus strongly recommended to set an HTTPS webhook instead (see HTTPS webhook). Note: CES 7.0.7183+ (November 2014) Setting an HTTPS webhook support.
Exclude details	Cleared
Events	All issue events Note: CES 7.0.8541+ (September 2016) For Jira Software (self-hosted) 7, only select the checkboxes under Issue.

Important: If the Exclude details check box is selected, your Jira Software permissions will not be updated. Leave the check box cleared.



5. Click Create.

Notes:

• By default, the live monitoring feature listens on the http://[YourCoveoMasterServer]/jira/CoveoCrawler/JiraWebHook web service endpoint.

  Important: Once you enable the webhook, it sends data each time an event occurred in Jira Software. If you use an unsecured HTTP webhook, be aware that it can expose potentially sensitive information. It is thus strongly recommended to set an HTTPS webhook instead (see HTTPS webhook).

  Note: CES 7.0.7183+ (November 2014) Support for setting an HTTPS webhook.

• If you have more than one Jira Software V2 source, create a webhook for each of your Jira Software V2 source by using the WebServiceEndpointName hidden parameter to replace the web service endpoint name (CoveoCrawler part) in the default web service endpoint URL (http://CoveoMasterServer/jira/CoveoCrawler/JiraWebHook).

  Example: When the WebServiceEndpointName hidden parameter value is changed to CoveoCrawler1, the web service endpoint URL becomes http://CoveoMasterServer/jira/CoveoCrawler1/JiraWebHook. You can then create another webhook using this URL.

• By default, live monitoring is enabled on a Jira Software V2 source. If you disable live monitoring, your source will not be updated other than with the full refreshes (see Toggling Live Monitoring for a Source) .

• CES 7.0.7183+ (November 2014) You can set the exposed secured endpoint to use an https connection between the Jira webhook and the crawler endpoint.

  • On a normal setup:

    1. Set the parameter WebServiceEndpointUseHttps to true (see Modifying Hidden Atlassian Jira Software V2 Source Parameters).

    2. Configure the port 443 with the ssl certificat. You can use the command netsh http add sslcert ipport=0.0.0.0:443 certhash=[tumbprint] appid={[crawler appid]} (see How to: Configure a Port with an SSL Certificate).

  • When you use self-signed certificate, you must export the certificate in Base64 from the machine where the Coveo Master server is located and add it into the Java KeyStore of Jira:

    • On the machine where Coveo Master server is located:

      1. Open Internet Information Services (IIS) manager.

      2. Under Connections, click the server name, and then Server Certificates.

      3. Select the good certificate, and then under Actions, select View.

      4. On the Details tab, click Copy to File.

      5. In the Welcome to the Certificate Export Wizard window, read, and then click Next.

      6. In the Export Private Key window, select the No, do not export the private key check box, and then click Next.

      7. In the Export File Format window, select the Base-64 encoded X.509 (.CER) check box, and then click Next.

      8. In the File to Export window, in the File Name box, enter the name of the certificate you want to export.

         By default, the file is saved in the C:\windows\system32\ folder.

      9. In the Completing the Certificate Export Wizard window, click Finish.

    • On the Jira Software machine:

      1. Open Command Prompt.

      2. Run the following command to import the certificate into the Java KeyStore:

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

      3. Enter changeit, the default Java TrustStore password, when asked for a password.

    If you try to setup an HTTPS webhook with a self-signed certificate and encountered problems, refer to the Jira documentation (see SSLHandshakeException - unable to find valid certification path to requested target).