How to Configure JIRA Webhook to Trigger Bamboo Build
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
This article describes how JIRA Webhooks can be configured to trigger a Bamboo Build using Bamboo REST APIs (Build Queue Service).
Solution
1. Understand how Build Queue Service works
The following REST API endpoint can be used (e.g. with curl) to trigger a Bamboo build:
1
curl -X POST -u admin:password http://bamboo-host:8085/rest/api/latest/queue/PLAN-KEY?os_authType=basicReplace:
adminwith a Bamboo username that has the permission to trigger a buildpasswordwith the respective user's passwordhttp://bamboo-host:8085with Bamboo's Base URLPLAN-KEYwith the Bamboo plan key for which a build is to be triggered
ℹ️ Ensure the curl command works before moving on to section #2 below.
2. How Build Queue Service can be triggered using JIRA Webhooks
The URL in section #1 above can be translated to a Webhook URL as follows:
1http://admin:password@bamboo-host:8085/rest/api/latest/queue/PLAN-KEY?os_authType=basicusername and password are inserted in between the Base URL (after the double slashes and before the hostname) using the format
username:password@When configuring Webhooks, the option
Exclude bodymust be checked
Example: A Build will be triggered when a Comment is added in a JIRA Issue
Was this helpful?