Skip to main content
Skip table of contents

Global Configurations for Bitbucket admins

Get started guide for Bitbucket administrators.

Configuration

Repository configurations by default overrides project and global configurations, and project configurations by default override global settings. But this parameter is configurable in the repository and project settings.

To start the Post Webhooks for Bitbucket plugin configuration you have to add a new webhook on the Global configuration page:

  1. Move to the Bitbucket Administration section (“gear” button in the right corner of the navigation menu).

  2. Navigate to the Add-ons section and find our application Post Webhooks.

  3. On the Global Configuration page, navigate to the Configurations tab.

  4. Click on Add webhook in the left corner and create a new configuration. After you have specified all the necessary parameters click on the Save button.

On the Configurations tab, you also can see all webhooks created on the repository and project levels. On Global level you can set up only 1 configuration .

Below you can find a short definition of each parameter you have to specify:

Parameter

Definition

Title

the name of the configuration

Our advice is to name something meaningful to you and your team so that it can be understood later easier.

URL

resourse where the data should be sent. Also you have to specify the HTTP method to be used when making requests to the target URL:

  • POST;

  • PUT;

  • GET.

Skip URL Validation

by enabling this parameter the app will allow you to use URLs that may not conform to the standard validation rules

Enable Authentication

the app adds an authentication mechanism to the webhook requests, ensuring that only authorized parties can access the webhook endpoint. By enabling this option you have to specify:

  • Authentication type - the type of authentication to be used when sending requests to the webhook URL: Basic, Bearer or Kerberos authentication;

Kerberos authentication is available since 3.22.12

  • depending on type you choose you have to specify authentication details, such as, Username, Password or Token.

Enable Mutual TLS

enabling mutual TLS ensures that only trusted clients with valid and verified certificates can establish a connection with the webhook endpoint. By enabling this option you have to specify folowing parameters:

  • Path to Key Store - contains the private key and the associated certificate used for Mutual TLS authentication.

  • Path to Trust Store - contains trusted certificates used to verify the authenticity of other parties during Mutual TLS authentication.

  • Key Store Password - the password required to access the Key Store file.

  • Trust Store Password - password needed to access the Trust Store file.

Skip SSL Certificate Validation

this parameter instructs the app to skip the validation of SSL certificates, allowing the connection to be established even if the certificate cannot be verified.

Payload type

allows you to specify which payload type should be sent.

Supports:

  • Jenkins

  • Azure DevOps

  • Microsoft Teams

  • Bitbucket (native format)

  • GitHub

The Azure DevOps pipeline that should be triggered when the webhook event occurs. By enabling this option additionality you have to specify folowing parameters:

To trigger GitHub workflow use the following parameters,

  • the URL should have the following format https://api.github.com/repos/{REPO_OWNER}/{REPO_NAME_SLUG}/actions/workflows/{workflow.yml_FILE}/dispatches

  • The payload to send contains key value set of parameters your workflow expects.

  • Example of the payload

CODE
{"ref": "master", "inputs":{"eventType": "{eventType}","projectKey": "{projectKey}", "repositorySlug": "{repositorySlug}","branch": "{branch}"}}

Find more details on GitHub workflow integrations with Bitbucket here

Trigger GitHub workflows

Committers to ignore

the comma-separated list of Bitbucket user names that should NOT trigger an event. This is often used to ignore pushes from your continuous integration user.

Important: not display names, but usernames. For instance, jenkins-user.

Repository pattern

a pattern or regular expression that defines the repositories for which the webhook should be triggered. Commits on these repositories will trigger this hook.

For instance, .*-Jenkins

From branches to consider

the comma-separated list of Bitbucket branch regular expressions that should be considered when filtering events.

For instance, release/*, tag/*, etc.

Destination branches to consider

the comma-separated list of Bitbucket branch regular expressions should be considered when filtering events for pull requests only.

From branches to ignore

the comma-separated list of Bitbucket branch regexes that should be ignored.

Destination branches to ignore

the comma-separated list of Bitbucket branch regexes that should be ignored.

Status

Active checkbox should be enabled if this configuration is going to be used.

Skip CI

lets skip triggering events for commits/pull requests that include the [skip ci] or [ci skip] keywords in their title or description.

File path pattern

comma-separated list of file paths, only commits on these file paths will trigger the webhook.

For example, src/java/.*/src/main/resources/.*properties will trigger events only for the changes in the properties files.

Skip personal

skipping of the events from personal projects and repositories.

Include projects

comma-separated list of Bitbucket project keys that will trigger this event.

Exclude projects

comma-separated list of Bitbucket project keys that will be IGNORED for this event. This could be used with the combination of Include projects empty (include all).

Repository events

allows you to specify the types of events that should trigger the webhook.

Pull request events

Once the webhook has been created, you can start using app. The rest configurations are optional to make your integrations more streamlined and efficient.

A table of created webhooks provides a centralized view of all webhooks configured across your Bitbucket instance. It allows you to see the complete list of webhooks in one place, making it easier to manage and monitor them.

You can quickly filter the webhooks list you need to manage with the help of configuration filtering fields. Filtering is possible by project name and repository name.

For the selected webhooks list you are able to apply the following actions:

  • disable;

  • enable;

  • delete.

Global settings

The Global Settings tab allows Bitbucket administrators to configure and customize the integration settings.

Here you can specify the list of parameters applied to the rest configuration levels located in Project Settings and Repository settings.

Below you can find a short definition of each parameter:

Parameter

Definition

Multiple configurations

checkbox enables allowing multiple configurations per level

This setting permits to have multiple configurations on the project and repository levels. Global configuration can be only 1.

Append "server_url"

determines whether the server URL should be appended to the target URL when sending webhook requests. It can be useful when the target system requires the server URL as part of the request.

Enable repositories scan for build status

enables the app to scan repositories for build status information.

Disable configuration if project/repository was moved/deleted

Available since 3.12

controls whether the app should disable a configuration if the associated project or repository in Bitbucket is moved or deleted.

Not valid configurations are marked in yellow and shown only at the global level so that the global admin can amend or delete them.

In the older versions, you may see RepositoryMovedException. Follow this guide to delete/change older issues. But the best option here is to update to the latest version and fix the highlighted rule in the Global configuration.

Execute global level rules additionally to lower-level rules

allows global-level rules to be executed independently (or on top) of the lower-level rules (e.g., repository or project level rules).

If this setting is disabled the rules are combined into 1 rule for a particular event. But if this setting is enabled, it may cause double notifications if the rules on different levels are configured to override some settings and notify the same 3rd party system.

Execute project level rules additionally to repository level rules

determines whether project level rules should be executed independently of repository level rules.

These two parameters Execute global level rules additionally to lower-level rules and Execute project level rules additionally to repository level rules meant to be used when you want the app works independently on each level.

Repo or project admins set up their own configurations. Alternatively, by default, the rules are merged for each repository.

Allowed projects

a list of allowed projects, only repositories within these projects will be considered for webhook execution.

Forbidden projects

a list of forbidden projects, repositories within these projects will be excluded from webhook execution.

Modification permit for writers

repository writers to use REST APIs to manage configurations.

Modification permit for readers

repository writers are allowed to use REST APIs to manage configurations.

Disable Old Rest API

disables the use of the old REST API for webhook execution.

Request timeout

the timeout duration for webhook requests; if the target URL doesn't respond within the specified time, the request will be considered as timed out.

The default value is 30 sec.

Request retry count

the number of times the app should retry failed webhook requests before giving up

Bitbucket base URL

the base URL of your Bitbucket server or cloud instance

Query string parameters support

How to use query string parameters

Maintenance

The Maintenance tab in the global configurations serves for managing and maintaining the webhook configurations ensuring their reliability and optimal performance.

Below you can find a short definition of each parameter:

Parameter

Definition

Export configurations

export the current webhook configurations to a file. It is useful for creating backups or for migrating configurations to another instance of the app or Bitbucket server.

Import configurations

import webhook configurations from a previously exported file. It enables easy restoration of configurations or migration to a new instance of the app or Bitbucket server.

Show all configurations migration result

this parameter displays the result of the migration process when importing configurations. It helps you identify any issues or errors encountered during the migration and allows for troubleshooting if needed.

Working queue

allows you to monitor and manage the webhook events that are currently in the app's working queue:

  • Current amount of tasks shows the current number of tasks being processed by the app.

  • Remove number of the oldest tasks allows you to remove a specified number of the oldest tasks from the app's task queue.

Rerun data migration

There is a Dangerous zone in the Maintenance tab, where you can delete all existing configurations and rerun migration from older (free) versions.

We recommend backup all data first.

Debugging and troubleshooting

Please follow this how-to article -


How to set up Azure DevOps Pipeline triggering from Bitbucket Server?

How to integrate Bitbucket Server with Jenkins Pipelines?

How to enable notifications from Bitbucket in Microsoft Teams?

How to choose an authentication type?

How to use Mutual TLS for Jenkins and Bitbucket integration?

How to fix RepositoryMovedException error?

Updated:

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.