Saltar al contenido principal

Bitbucket Toolkit

The Bitbucket Toolkit is a workflow node. Its tools include List Repositories, Get Repository, Search Repositories, and Get File Content, plus 8 more listed below. Connect a Bitbucket account before you use any of these tools. Type @ in a field when the value should come from an earlier step.

Authentication​

Every Bitbucket tool needs a connected account before it can run. On the node, open Bitbucket Account.

  1. Choose Use my Bitbucket account or Use team account.
  2. If no personal account is connected, click Connect Bitbucket Account and finish sign-in.
  3. For a team account, choose Use team account and pick one from Team account. The list shows accounts already connected for the project.

Tools​

List Repositories​

Lists repositories.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.
WorkspaceNoWorkspace slug to filter repositories (optional, uses all accessible workspaces if not provided). Default is null. Type @ to select a variable.
RoleNoFilter by role: 'owner', 'admin', 'contributor', 'member'. Default is null. Type @ to select a variable.
SortNoSort by: 'name', 'created_on', 'updated_on' (prefix with - for descending). Default is -updated_on. Type @ to select a variable.
PageNoPage number for pagination. Default is 1.
PagelenNoNumber of repositories per page (1-100). Default is 30.

Get Repository​

Retrieves repository.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.
WorkspaceYesWorkspace slug (username or team name). Type @ to select a variable.
Repo SlugYesRepository slug. Type @ to select a variable.

Search Repositories​

Searches repositories.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.
QueryYesSearch query string. Type @ to select a variable.
SortNoSort by: 'name', 'created_on', 'updated_on' (prefix with - for descending). Default is -updated_on. Type @ to select a variable.
PageNoPage number for pagination. Default is 1.
PagelenNoNumber of repositories per page (1-100). Default is 30.

Get File Content​

Retrieves file content.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.
WorkspaceYesWorkspace slug (username or team name). Type @ to select a variable.
Repo SlugYesRepository slug. Type @ to select a variable.
PathYesFile path in the repository. Type @ to select a variable.
RefNoBranch name, tag, or commit hash (defaults to main branch). Default is null. Type @ to select a variable.

List Branches​

Lists branches.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.
WorkspaceYesWorkspace slug (username or team name). Type @ to select a variable.
Repo SlugYesRepository slug. Type @ to select a variable.
SortNoSort by: 'name', 'target.date'. Default is -target.date. Type @ to select a variable.
PageNoPage number for pagination. Default is 1.
PagelenNoNumber of branches per page (1-100). Default is 30.

List Pull Requests​

Lists pull requests.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.
WorkspaceYesWorkspace slug (username or team name). Type @ to select a variable.
Repo SlugYesRepository slug. Type @ to select a variable.
StateNoPR state: 'OPEN', 'MERGED', 'DECLINED', 'SUPERSEDED'. Default is OPEN. Type @ to select a variable.
SortNoSort by: 'created_on', 'updated_on'. Default is -updated_on. Type @ to select a variable.
PageNoPage number for pagination. Default is 1.
PagelenNoNumber of PRs per page (1-100). Default is 30.

Get Pull Request​

Retrieves pull request.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.
WorkspaceYesWorkspace slug (username or team name). Type @ to select a variable.
Repo SlugYesRepository slug. Type @ to select a variable.
Pull Request IDYesPull request ID.

Create Pull Request​

Creates pull request.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.
WorkspaceYesWorkspace slug (username or team name). Type @ to select a variable.
Repo SlugYesRepository slug. Type @ to select a variable.
TitleYesPull request title. Type @ to select a variable.
Source BranchYesSource branch name. Type @ to select a variable.
Destination BranchYesDestination branch name. Type @ to select a variable.
DescriptionNoPull request description. Default is null. Type @ to select a variable.
Close Source BranchNoClose source branch after merge. Default is false.

List Issues​

Lists issues.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.
WorkspaceYesWorkspace slug (username or team name). Type @ to select a variable.
Repo SlugYesRepository slug. Type @ to select a variable.
StateNoIssue state: 'new', 'open', 'resolved', 'on hold', 'invalid', 'duplicate', 'wontfix', 'closed'. Default is null. Type @ to select a variable.
SortNoSort by: 'created_on', 'updated_on', 'priority'. Default is -updated_on. Type @ to select a variable.
PageNoPage number for pagination. Default is 1.
PagelenNoNumber of issues per page (1-100). Default is 30.

Create Issue​

Creates issue.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.
WorkspaceYesWorkspace slug (username or team name). Type @ to select a variable.
Repo SlugYesRepository slug. Type @ to select a variable.
TitleYesIssue title. Type @ to select a variable.
ContentNoIssue description/content. Default is null. Type @ to select a variable.
KindNoIssue kind: 'bug', 'enhancement', 'proposal', 'task'. Default is bug. Type @ to select a variable.
PriorityNoIssue priority: 'trivial', 'minor', 'major', 'critical', 'blocker'. Default is major. Type @ to select a variable.

Get Commit History​

Retrieves commit history.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.
WorkspaceYesWorkspace slug (username or team name). Type @ to select a variable.
Repo SlugYesRepository slug. Type @ to select a variable.
BranchNoBranch name (defaults to main branch). Default is null. Type @ to select a variable.
PageNoPage number for pagination. Default is 1.
PagelenNoNumber of commits per page (1-100). Default is 30.

Get Workspaces​

Retrieves workspaces.

FieldRequiredDescription
Bitbucket AccountYesSelect your personal or team Bitbucket account.

Agents can use this integration from chat. See Bitbucket.

See all integrations on the toolkits overview.