Skip to main content
Adding a Webhook to Jira

To get instant updates from Jira to piplanning.io, you will need to setup a Webhook in Jira pointing to piplanning.io.

Updated over 8 months ago

The URL property you will need to set up in the Jira Webhook - for the bi-directional piplanning.io integration - are displayed on the page in the RTE Cockpit. Under the Webhook tab on the ALM Configuration you will find the details.

The properties needed when creating the Jira - Webhook (in your Jira Software instance) are displayed on the Webhook tab in the ALM Connection

Instructions to setup the Jira WebHook

  1. Login (or remain logged in) to your Jira instance with the System User (with the required permissions) account that was used to authenticate with piplanning.io.

  2. Navigate to System under Jira Settings.

  3. Scroll down to the ADVANCED section and select WebHooks (Note: the capital H is how it displays in Jira)

  4. Click the +Create a WebHook button

  5. Enter a Name (an alias or friendly name of your choice) and copy+paste the URL shown in the piplanning.io > ALM Connections > Webhook tab in the RTE Cockpit.

    • Optional: Enter a Description to assist other system administrators.

  6. For EVENTS > Issue related events, please ensure the following checkboxes are active (checked).

    1. Issue: created, updated, deleted

    2. Issue link: created, deleted

      Jira Issue related events to check on the Jira Webhook setup.

  7. Click Create


Recommendation: Ignore Jira Webhooks fired by a Jira System User

Introduced in April 2024: IF you have a Jira Systems User account used for the authentication and synchronization to Jira, than we strongly recommend enabling this setting.
โ€‹
โ€‹Why? The reason for using this setting is that it has helped resolve performance issues that can occur when the Jira Webhooks are triggered quicker than the Jira REST API responses.

Here is what you need to do:

  • Please, check the checkbox Ignore webhooks fired by sync-user

When checked, piplanning.io will not process any Jira Webhooks which are triggered by the Jira System User that is used to authenticate the integration.


THE END: That's all that is needed in regards to the Jira Webhook. Thank you for setting that up on your Jira Software instance. Now updates in Jira will be synchronized to piplanning.io so the integration is now bi-directional (real-time).

Back in the RTE Cockpit on the ALM Connection page click Save and next button to move to the Team Mapping tab.

Did this answer your question?