Skip to main content
Debugging Jira WebHooks

If you observe that updates from Jira to piplanning.io are not synchronizing in real-time, then troubleshooting Jira WebHooks is important.

Updated over 3 months ago

If you are observing that updates made in Jira Software (Cloud or Data Center) are not being reflected in piplanning.io then there is likely an issue with the Jira WebHooks. Use the suggestions in this article to perform some debugging or troubleshooting tasks, find the root cause, and resolve the issue.
​
​In general: the Jira WebHook events might not be triggering or there might be a network issue that prevents the Jira WebHook from reaching the piplanning.io servers. Here are series of steps to take to debug the issue, kind of our own manual IFTTT process...


Overview of Jira WebHooks Debugging Steps

  1. Verify the Webhooks setup in your instance of Jira Software [Cloud, Server] can reach the internet. Can the Jira WebHooks connect to the outside world?
    ​

  2. Jira Software Data Center ONLY: Verify that a HTTP/S request sent from your on-premise Jira Software instance to our piplanning.io servers/listeners succeeds.

  3. Verify in your Jira instance that the Jira WebHook Add-on/Apps (modules) are activated, and 2nd that the WebHooks are being triggered.

Known bug in Jira & Java v11

WebHooks do not work in Jira Server running on Java v11: https://jira.atlassian.com/browse/JRASERVER-70780


Verify Jira is sending WebHooks to the outside world

Test Plan: Create a new WebHook in Jira and set the URL to the test URL generated by the https://webhook.site. The instructions are as follows:

  1. Go to the website: https://webhook.site

  2. Find the Your unique URL field. We will copy the value from this field.

  3. Copy (click Copy) on the Your unique URL field.

    Important: Please copy the Your unique URL value using the Copy link, do NOT copy from the URL address bar!)


    ​Note: Keep this browser tab open for this webhook.site page because we will refer to it later to get the test result.

  4. Navigate to Jira > System > WebHook.

  5. Create a NEW WebHook in Jira using that value from the (webhook.site) Your unique URL field. This new Jira WebHook is for testing purposes only and you can delete it after the test is validated.

    Note: create this new Jira WebHook with the same Issue related events and Jira Software related events (Sprints, Boards) as described in our documentation for Add Jira WebHook (link TBP).

  6. Return to the Jira UI, please Create or Update an Issue in Jira to trigger the Jira WebHook.

    Note: Changing a field in Jira is supposed to trigger the event that fires a WebHook.

  7. Navigate back to the https://webhook.site page, and observe if you see any WebHook requests.

    Question: Is there a Jira WebHook received by https://webhook.site? πŸ€“

Use the public site <a href="https://webhook.site/" target="_blank" rel="nofollow noopener noreferrer">https://webhook.site/</a> to verify piplanning.io is receiving your Jira WebHooks.

Screenshot of the https:/.webhook.site and testing WebHooks.


Verify the Jira WebHooks are received by piplanning.io

  1. Go to the RTE Cockpit > ALM Connections > Jira - Webhook page.

  2. Copy the URL on the Jira - WebHook setup page directly into a browser tab

    Edit the ALM Connection to retrieve the Jira WebHook Listener URL

    Edit the ALM Connection to retrieve the Jira WebHook Listener URL

  3. Important: Perform some actions in Jira to trigger the WebHook events. Actions such as: move User Stories into a Sprint, edit the Name of a User Story. Create/Update User Stories or any Jira Issues that is in the Jira WebHook scope (JQL).

  4. Return to the browser tab and validate that the entries in the JSON response and the last_request_timestamp array.

JSON response from pasting the Jira WebHook Listener URL into the browser

Valid JSON response from pasting the Jira WebHook Listener URL into the browser to verify Jira WebHooks are being received by piplanning.io servers.


Jira Software Data Center ONLY: Verify a HTTPS request from the Jira host server reaches piplanning.io

Note: Skip this test if you are using Jira Cloud

  1. Open a Terminal window on the Jira Software host machine to access the Shell.

  2. In the Shell program (Linux) from the command line issue the following command:

    curl -v -d "test=1" -X POST https://wlistener2.piplanning.io/foo:jira:bar

  3. IF the request fails (Timeout, DNS error. etc.), then it is most likely a network issue (e.g. Firewall). Please investigate with the appropriate network team and resolve this.

In case you need to import the CA certificate of our cert-issuer to the Jira trust store, please follow these steps:


Verify Jira WebHooks are actually firing...

Check if the Jira WebHook is being triggered in Jira.
​Jira Community Post: Jira WebHook does not send triggers.

  1. Choose step 1 a). or 1 b). depending on the Jira Software instance you have:

    1. Jira Server or Data Center (On-Premise): Jira Administration β†’ System β†’ Logging and profiling β†’ Configure logging level for another package

    2. Jira Cloud: Settings > Jira Settings > System > TROUBLESHOOTING AND SUPPORT.

  2. Enter com.atlassian.webhooks for the Package name β†’ Set Logging Level to DEBUG β†’ Add

    Note: For more verbose logging, enter org.apache.http for the Package name β†’ Set Logging Level to DEBUG β†’ Add

  3. Mark the logs as per Marking Jira logs for troubleshooting purposes to indicate Replication Start

  4. Trigger the WebHooks (a single event should be able to trigger both WebHooks)

    Note: This will only log an entry when the WebHook has been triggered, so if you don't see any entries, the WebHook is not triggering.

What you should see in the log file is an entry like this:

AO_4AEACD_WEBHOOK_DAO {ID = 1} 55838

<Possible warning / errors from Jira will appear here>

The location of the log depends on configuration settings, and by default, you will find the logs in this directory (Linux) /opt/atlassian/jira/logs/catalina.log


Verify the Jira WebHooks Add-on (modules) are Activated

For Jira Cloud

  1. Go to Settings > Jira Settings > Apps

  2. Click Manage apps menu in the left menu navigation.

  3. In the first filter box in the right pane, the default text reads Filter visible apps, , enter WebHook

  4. In the second filter box, select the dropdown and select System

  5. Confirm the two (2x) WebHooks Plugins are installed, refer to the screenshot.

    1. Atlassian Jira - Plugins - WebHooks Plugin

    2. Atlassian WebHooks Plugin

Note: These Apps are an integral part of your Jira system and at the time of writing this article they are provided by the Universal Plugin Manager (v1001.0.0.SNAPSHOT) by Atlassian [on Jira Software Cloud].
​

Jira Software - Systems Managed Apps - WebHook Plugin - confirm it is installed and activated.

Other Helpful Links

Did this answer your question?