Configuration

Configuration is started in Bitbucket and completed in Mattermost.
Step 1: Register an OAuth Application in Bitbucket
1.Go to https://bitbucket.org and log in.
2.From your profile avatar in the bottom left, select the workspace in the Recent workspaces list or select All workspaces for a full list.
Select Settings in the left sidebar to open the workspace settings.
Under Apps and features, select OAuth consumers.
3.Select Add consumer and set the following values:
Name: Mattermost Bitbucket Plugin - <your company name>.
Callback URL: https://your-mattermost-url.com/plugins/bitbucket/oauth/complete, replacing https://your-mattermost-url.com with your Mattermost deployment's Site URL.
URL: https://github.com/mattermost/mattermost-plugin-bitbucket.
4.Set:
Account: Email and Read permissions.
Projects: Read permission.
Repositories: Read and Write permissions.
Pull requests: Read permission.
Issues: Read and Write permissions.
5.Save the Key and Secret in the resulting screen.
6.Go to System Console > Plugins > Bitbucket
7.Enter the Bitbucket OAuth Client ID and Bitbucket OAuth Client Secret you copied in a previous step.
8.Select Save.
Step 2: Create a webhook in Bitbucket
You must create a webhook for each repository you want to receive notifications for or subscribe to.
1.Go to the Repository settings page of the Bitbucket organization you want to send notifications from, then select Webhooks in the sidebar.
2.Select Add Webhook.
3.Set the following values:
Title: Mattermost Bitbucket Webhook - <repository_name>, replacing repository_name with the name of your repository.
URL: https://your-mattermost-url.com/plugins/bitbucket/webhook?secret=SOME_SECRET
replace https://your-mattermost-url.com with your Mattermost deployment's Site URL.
replace SOME_SECRET with the secret generated in System Console > Plugins > Bitbucket > Webhook Secret.
4.Select Choose from a full list of triggers.
5.Select:
Repository: Push.
Pull Request: Created, Updated, Approved, Approval removed, Merged, Declined, Comment created.
Issue: Created, Updated, Comment created.
6.Select Save.
If you have multiple repositories, repeat the process to create a webhook for each repository.
Step 3: Configure the plugin in Mattermost
If you have an existing Mattermost user account with the name bitbucket, the plugin will post using the bitbucket account but without a BOT tag.
To prevent this, either:
1.Convert the bitbucket user to a bot account by running mattermost user convert bitbucket --bot in the CLI.
or
1.If the user is an existing user account you want to preserve, change its username and restart the Mattermost server. Once restarted, the plugin will create a bot
account with the name bitbucket.
Generate a Key
Open System Console > Plugins > Bitbucket and do the following:
1.Generate a new value for At Rest Encryption Key.
2.(Optional) Bitbucket Organization: Lock the plugin to a single Bitbucket organization by setting this field to the name of your Bitbucket organization.
3.Select Save.
4.Go to System Console > Plugins > Management and select Enable to enable the Bitbucket plugin.
You're all set!

Admin Guide - Previous

Installation

Next - Admin Guide

Onboarding Users

Last modified 5mo ago

Copy link

Edit on GitHub

Contents

Step 1: Register an OAuth Application in Bitbucket

Step 2: Create a webhook in Bitbucket

Step 3: Configure the plugin in Mattermost

Generate a Key