Bitbucket Connector

How it works#

The Bitbucket Connector indexes all Pull Requests from a specified Bitbucket Cloud repository, project, or entire workspace.

• It indexes OPEN, MERGED, and DECLINED pull requests, including their titles and descriptions.

• It also captures key metadata such as the author, reviewers, current state, creation/update timestamps, and a direct link back to the original pull request in Bitbucket.

Setting up#

This connector can only be used with Bitbucket Cloud.

Authorization#

The Bitbucket Connector uses an API Token for authentication.

To create an API token:

Log in to Bitbucket#

Log in to your Bitbucket account.

Open account settings#

Select the Settings cog in the upper-right corner of the top navigation bar.

Access Atlassian account settings#

Under Personal settings, select Atlassian account settings.

Go to the Security tab#

Select the Security tab on the top navigation bar.

Manage API tokens#

Select Create and manage API tokens.

Create a scoped token#

Select Create API token with scopes.

Name the token#

Give the API token a name and an expiry date, usually related to the application that will use the token and select Next.

Choose Bitbucket#

Select Bitbucket as the app and select Next.

Select scopes#

Select the scopes (permissions) the API token needs and select Next.

• Projects: read:project:bitbucket

• Repositories: read:repository:bitbucket

• Pull Requests: read:pullrequest:bitbucket

Create the token#

Review your token and select the Create token button. The page will display the new API token.

Save the token#

Copy the generated API token and either record or paste it into the application you want to give access.

The token is only displayed once and can't be retrieved later.

For the most up-to-date instructions, refer to the official Bitbucket documentation.

Indexing#

Open the Bitbucket connector#

Navigate to the Admin Dashboard and select the Bitbucket Connector.

Create credentials#

Click Create new credentials and provide the following:

• Name: A descriptive name for your credentials.

• Email: The email address for your Bitbucket account.

• API token: The API token you created in the previous step.

Configure connector details#

Fill in the connector details:

• Name: A descriptive name for the connector.

• Workspace name: The WORKSPACE_NAME from your Bitbucket URL (https://bitbucket.org/{WORKSPACE_NAME}/...).

• Repositories or Projects (Optional): A comma-separated list of repository slugs or project keys to index.

This configuration will index all pull requests from the specified repositories. You can also configure it to index all repositories within a project or an entire workspace.

Before using this source with students#

Start with approved course material. Check which documents the connector can retrieve and how it maps source permissions. Test with a student account and a teacher account before widening access. A successful sync does not prove that the intended class boundary is correct.

Use source troubleshooting when a document is missing or visible to the wrong audience.