Configure Webhook to Jenkins for Bitbucket Cloud

Once Webhook to Jenkins for Bitbucket Cloud has been successfully installed, the next step is configuring the app in Bitbucket Cloud. You can configure Connections and Hook settings at the Workspace or Repository level.

Open Webhook to Jenkins from a workspace

1. Log in as an Administrator and select the profile avatar in the top-right corner of any Bitbucket page.

2. Select the applicable workspace from the Recent Workspace list or select All Workspaces and the workspace from the list.

3. Click Settings next to the profile avatar and select Workspace settings from the Settings options.

   Open

   

4. When the Workspace settings page opens, scroll to the bottom of the left sidebar and select Webhook to Jenkins for Bitbucket under Webhook to Jenkins for Bitbucket Cloud.

The Webhook to Jenkins for Bitbucket page opens.

Open

A	Connections	Connect to Jenkins servers to use in your integration.
B	Hook Settings	Set your Jenkins instance at the Repository levels, configure options, and test the configuration settings once set. Configure specific events that trigger Jenkins builds and test configuration in each repository’s settings.
C	WBJJ	select the WBJJ icon and select: Documentation - opens the Webhook to Jenkins for Bitbucket Cloud documentation pages Get Support - opens the Appfire Atlassian support page
D	Search	Search for specific Jenkins server instances. Type a portion of the Jenkins server address into the search bar. When the server appears in the list, select the Options icon for the server entry and select: Edit - modify the Server configuration options Delete - remove the Jenkins Instance
E	Add Jenkins Instance	Opens the Add Jenkins Instance dialog
F	Connections list	List of previously created connections. Each entry has: Jenkins URL - the URL of the Jenkins instance Scope - indicates if the connection is at the Workspace or Repository level Project (repository level only) - for connections created at the repository level, this indicates the project where the repository resides Repository (repository level only) - the name of the repository the connection is for

You are currently in Webhook to Jenkins for Bitbucket Cloud documentation.

On this page: 1 Open Webhook to Jenkins from a workspace 2 Configuration 2.1 Add a connection 2.2 Hook Settings 2.3 Settings 2.4 Advanced 2.5 Job Parameters 2.6 Available Parameters 2.7 General 3 Open Webhook to Jenkins from a repository 4 Add a Connection 4.1 Create a connection at the repository level

Related articles: Manage Webhook to Jenkins for Bitbucket Cloud Webhook to Jenkins for Bitbucket Cloud - Configure Jenkins Access token requirements for Git plugin - Webhook to Jenkins for Bitbucket Cloud

Configuration

Add a connection

1. Select Add Jenkins Instance to open the Add Jenkins Instance dialog.

2. Enter the URL to the Jenkins instance. This is the base URL for your Jenkins instance, not a link to a specific job—for example, https://abc.yourtestingjenkins.net.

3. Enter the Jenkins Username and Password associated with the Jenkins job you want to connect to. If you are configuring Webhook to Jenkins to use the Direct Job trigger, you must fill in your Jenkins credentials here.

4. If you are using Git plugin version 4.11.4 or higher, enter the notifyCommit access token. See Access Token Requirements for Git plugin for instructions regarding generating and using the token.

5. Click Save.

The server instance now appears in the Jenkins Server list with a new status and Workspace, indicating this is a workspace-level connection, rather than a repository-level.

When you create a Jenkins connection, information and direction regarding the next configuration step opens in the bottom-left corner of the page. Click Hook settings to continue to that tab.

Hook Settings

Set your Jenkins instance hook settings at either the Workspace or Repository level, configure options, and test the configuration settings once they have been set.

1. Select the Hook Settings tab.

2. Select a Project and Repository from the dropdown lists to see any instances that exist for that project/repository pair.
   Any current hook settings instances in the list display the Status (enabled or disabled), the Project name, and the Repository name.

3. Select Add to move to the New Hook settings configuration page.

4. Enable Webhook to Jenkins for this configuration.

5. Select the Project and Repository from the dropdown lists to associate the Bitbucket repository with a Jenkins job.

6. Select Add Jenkins instance to open the Instance Details dialog. If you select a Project/Repository pair with an existing configuration, the Configuration already exists message appears.

• Jenkins URL - Enter the URL to the Jenkins instance. This is the base URL for your Jenkins instance, not a link to a specific job. For example, https://abc.yourtestingjenkins.net.

• Jenkins Endpoint Notification Type - Select an endpoint from the following options:

  • Bitbucket Source plugin - This allows Jenkins to use Bitbucket Server as a source for multi-branch projects. It also provides the required connectors for the Bitbucket Server Project folder (also known as repositories auto-discovering). The Repo Clone URL and Check Poll SCM options are not used with the Bitbucket source Plugin.

  • Git plugin - Provides fundamental git operations for Jenkins projects. It can poll, fetch, checkout, branch, list, merge, tag, and push repositories.

  • Direct Job Trigger - This endpoint allows you to emulate clicking the Build Now button on the Jenkins job page for selected jobs. When the hook event is fired, it has the same effect as selecting this button manually for required jobs. Selecting this endpoint opens the Jobs List field. Type the name of the Jenkins job to see the list of matching jobs for this repository and select up to a maximum of five jobs to be triggered by Webhook to Jenkins. See Configure with Direct Job Triggers for more information.

• Repo Clone URL - URL that Jenkins uses to clone the repo. Select HTTP or SSH protocol, and Webhook to Jenkins populates the URL field automatically in that format, or select Custom and manually enter the URL.

  • HTTP - Configure Jenkins to use HTTP to clone the repo.

  • SSH - Configure Jenkins to use SSH to clone the repo.

  • Custom - Manually enter the URL for the Jenkins instance.

• Check Poll SCM - The Check Poll SCM notification appears in the Instance Details box. Select Go To Jenkins to access the Source Code Management section and make sure the Check Poll SCM option is selected. See Configure Jenkins - Webhook to Jenkins for Bitbucket Cloud for instructions.

Select Save when finished.

You can also add additional Jenkins instances. Select another project/repository pair and select Add Jenkins instance to repeat the process.

Settings

Project/Repository - The Project and Repository selected on the Hook Settings tab are carried through to the Settings tab.

Advanced

Committers to Ignore - Select or enter the names of Bitbucket committers or access keys whose pushes/merges should not trigger a Jenkins notification.

Branch/tag Options - Control the branches and tags allowed to be built from.
Select a branch option from the dropdown. Separate items with a space and use * for a wildcard at the end of each item.

Limit events - Select each event you want to trigger Jenkins. All events are selected by default except the Pull Request Approved option.

Trigger job poll if the branch is deleted - When a branch is merged or deleted in Bitbucket, select this option for Jenkins to remove the branch from its pipeline.

Job Parameters

The Job Parameters option sends custom URL parameters to Jenkins during the notification/trigger process. To use this option, you must also configure Jenkins to accept URL parameters. Refer to Send URL parameters to Jenkins for more information.

1. Under the Job parameters heading, enter the Parameter name. This is the same name used when configuring the parameter name in Jenkins.

2. Select a predefined parameter or type in a parameter value in the Parameter name field. You can also create a custom value by entering a string value containing any text that is not the same as a predefined parameter. This parameter must also be defined in Jenkins. See Send URL parameters to Jenkins for more information.

3. Click Add.

4. The name and value are added to the Job parameters list. Any custom value has a CUSTOM label attached when it appears in the list.

5. Click the Trash icon to remove the entry from the list.

Available Parameters

To pull information from Bitbucket to use as a parameter (like the branch name), refer to the table below.

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

When you have finished with the configuration, click Test to confirm your settings are valid. You’ll receive a Connection Succeeded message if your settings are valid, or a message providing details as to what settings requires investigation.

Click Save when finished.

General

• Skip SSL Validation - Self-signed certificates sometimes cause the client (Bitbucket) to deny the trigger build request. When selected, this option allows all certificates to be accepted, including self-signed certificates. We recommend only using the Skip SSL Validation option in select situations, such as in a test environment that uses self-signed certificates.

• Omit Builds page - This option removes the Webhook to Jenkins Builds menu item from the Repository side menu.

Open Webhook to Jenkins from a repository

You can also configure Webhook to Jenkins at the repository level.

1. Click the Repositories tab and select a repository. When the left sidebar menu opens, select Repository settings .

2. When the Repository details page opens, scroll to the bottom of the left sidebar and select Configure Webhook to Jenkins under Webhook to Jenkins for Bitbucket Cloud.
   The Webhook to Jenkins for Bitbucket page opens.

Add a Connection

Creating a connection to Jenkins at the repository level is similar to creating one at the workspace level. There are, however several differences in their behavior:

• connections added at a repository level are only visible at the workspace level or for that specific repository.

• you can create and edit connections according to the permissions you have. Workspace administrators can manage any connections, and repository admins can only manage the connections that belong to the repos to which they have access.

• when added to the Connections list, repo-level connections have a different scope and indicate the project and repository

• Connections created at the workspace level cannot be edited or deleted at the repository level.

Create a connection at the repository level

1. Click New Connection. The New Jenkins Connection page opens.

2. Enter the Jenkins URL. This is the base URL for your Jenkins instance, not a link to a specific job—for example, https://abc.yourtestingjenkins.net.

3. If you are using Git plugin version 4.11.4 or higher, enter the notifyCommit access token. See the Access Token Requirements for Git plugin - Webhook to Jenkins for Bitbucket Cloud article for instructions regarding generating and using the token.

4. Enter the Jenkins Username and Password associated with the Jenkins job you want to connect to. If you are configuring Webhook to Jenkins to use the Direct Job trigger, you must fill in your Jenkins credentials here.

5. Click Save.

The server instance now appears in the Jenkins Server list with a new status attached. Connections at the repository level also have a Repository as the Scope to indicate this connection is for a repository rather than the workspace. The Project and Repository names associated with the connection are also shown.

Follow the same procedures in the Hook Settings and Settings sections for your repository level configuration.