Jira Webhooks are the mechanism that is used to provide the sync from Jira to piplanning.io. This allows the synchronization to be bi-directional without needing to constantly poll Jira for updates. So, it's designed this way to minimize any impact on Jira.
Where to find the instructions for setting up the Jira Webhook
In the ALM Connection (Jira) > tab #2 Webhook you will find all the instructions for configuring the Jira Webhook for piplanning.io.
The URL property you will need to set up in the Jira Webhook is displayed on this page #2 Webhook (when editin the ALM Connection).
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
Be logged into your Jira instance as a Jira Admin User. Note: This may be different than the Jira User that was used to authenticate the ALM Connection.
In Jira Cloud, navigate to Settings > Jira admin settings > System
Scroll down to the Advanced section and select WebHooks
(Note: the capital H is how it displays in Jira)
Click the +Create a WebHook button
Enter a Name (an alias or friendly name of your choice)
Copy+paste the URL shown in the piplanning.io > ALM Connections > #2 Webhook tab in the RTE Cockpit.
Optional: Enter a Description to assist other system administrators.
Configure the Webhook to execute with the correct Events. Under Issue related events, please ensure the following checkboxes are active (checked).
Issue: created, updated, deleted
Issue link: created, deleted
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.
