Sending URL parameters to Jenkins

Webhook to Jenkins for Bitbucket version 4.2 and higher support sending custom URL parameters to Jenkins during the notification/trigger process. To use this feature, you must also configure Jenkins to allow URL parameters.

Setup

Configuring Jenkins

Git Plugin for Jenkins version 2.5.0 and higher will by default reject all URL parameters. You must configure Jenkins to allow URL parameters by doing ONE of the following:

• Setting the Jenkins JVM switches -Dhudson.model.ParametersAction.keepUndefinedParameters=true and -Dhudson.plugins.git.GitStatus.allowNotifyCommitParameters=true. This allows arbitrary notify commit parameters (reference). Only enable this if you trust all unauthenticated users not to pass harmful arguments to your jobs.

• Setting the Jenkins JVM switch -Dhudson.plugins.git.GitStatus.safeParameters=PARM1,PARM1. If this property is set to a comma-separated list of parameters, those parameters are allowed for any job. Only set this value for parameters you trust in all the jobs in your system.

For detailed instructions on adding Java arguments to Jenkins, see the CloudBees guide. 

Usage

Configure Bitbucket Server

1. Log in to your Bitbucket repository and navigate to Repository Settings > Hooks > Enable or click the Edit setting for Webhooks to Jenkins Server icon.

2. Click the  Advanced Configuration tab and locate URL Parameters at the bottom of the dialog.

3. Enter the URL parameter into the parameter field. The rules for the parameters are as follows:

   • The formatting for the URL parameter is DESIRED_VARIABLE_NAME={PARAMETER_NAME}. 

   • Every parameter starts on a new line.

   • The name given to your parameter is how you reference the parameter in Jenkins. In our example the parameter name is TARGET_BRANCH.

   • To pull information from Bitbucket to use as a parameter (like the branch name), refer to the Available parameters section and enter the parameter on the right side of the equal sign surrounded with curly braces {BRANCH_NAME}.

   • To use your own custom value, eliminate the curly braces and enter the value to the right of the equal sign.

Configure Jenkins

To access the parameter in your Jenkins job:

1. Go to your job, click Configure from the left sidebar and go to the General tab. Select This project is parameterized.

2. click Add Parameter and select String Parameter

3. in the Name field, enter the name of the parameter that you used in the Webhook to Jenkins URL Parameters field.

4. For each additional parameter, click Add Parameter, select String Parameter and enter the name of the next parameter.

5. Click Save.

Your parameters should now be passed to Jenkins.

Available Parameters

To pull information from Bitbucket to use as a parameter (like the branch name), refer to the table below and put the parameter on the right side of the equal sign and surround it with curly braces.

For example, TARGET_BRANCH={PR_DESTINATION}, where PR_DESTINATION is the branch name of the destination branch.