Skip to main content

Bitbucket

This Integration is part of the Bitbucket Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.5.0 and later.

Bitbucket Cloud is a Git-based code and CI/CD tool optimized for teams using Jira. This integration was integrated and tested with version 7.21.0 of Bitbucket

Configure Bitbucket on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for Bitbucket.

  3. Click Add instance to create and configure a new integration instance.

    ParameterRequired
    WorkspaceTrue
    Server URLTrue
    User NameTrue
    App PasswordTrue
    RepositoryFalse
    Trust any certificate (not secure)False
    Use system proxy settingsFalse
  4. Click Test to validate the URLs, token, and connection.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

bitbucket-project-list#


If a project_key is given, returns the requested project. Else, returns a list of the projects in the workspace.

Base Command#

bitbucket-project-list

Input#

Argument NameDescriptionRequired
project_keyThe "id" of the project. Must be uppercase.Optional
limitThe maximum number of projects to return. The default value is 50.Optional
pageThe specific result page to display.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.Project.typeStringThe type of the object.
Bitbucket.Project.owner.display_nameStringThe project owner name.
Bitbucket.Project.owner.linksStringLinks with information about the project owner.
Bitbucket.Project.owner.typeStringThe type of the project owner.
Bitbucket.Project.owner.uuidStringThe project owner universal unique ID.
Bitbucket.Project.owner.account_idStringThe project owner account ID.
Bitbucket.Project.owner.nicknameStringThe project owner nickname.
Bitbucket.Project.workspace.typeStringThe type of the workspace.
Bitbucket.Project.workspace.uuidStringThe project workspace universal unique ID.
Bitbucket.Project.workspace.nameStringThe name of the project workspace.
Bitbucket.Project.workspace.slugStringThe slug of the project workspace.
Bitbucket.Project.workspace.linksStringLinks to information about the workspace.
Bitbucket.Project.keyStringThe project key.
Bitbucket.Project.uuidStringThe project universal unique ID.
Bitbucket.Project.is_privateBooleanWhether the project is private.
Bitbucket.Project.nameStringThe project name.
Bitbucket.Project.descriptionStringThe project description.
Bitbucket.Project.linksStringLinks to information about the project.
Bitbucket.Project.created_onStringThe date the project was created.
Bitbucket.Project.updated_onStringThe date the project was updated.
Bitbucket.Project.has_publicly_visible_reposBooleanWhether the project has publicly visible repositories.

Command example#

!bitbucket-project-list

Context Example#

{
"Bitbucket": {
"Project": [
{
"created_on": "2022-08-24T09:25:07.11111111+00:00",
"description": "description",
"has_publicly_visible_repos": false,
"is_private": true,
"key": "AP",
"links": {
"avatar": {
"href": "https://bitbucket.org/account/user/workspace/projects/AP/avatar/11?ts=111111111"
},
"html": {
"href": "https://bitbucket.org/workspace/workspace/projects/AP"
},
"repositories": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace?q=project.key=\"AP\""
},
"self": {
"href": "https://api.bitbucket.org/2.0/workspaces/workspace/projects/AP"
}
},
"name": "Another Project",
"owner": {
"account_id": "111111111111111111111111",
"display_name": "Display Name",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/avatar-management--avatars.us-west-2.prod.public.atl-paas.net1111.png"
},
"html": {
"href": "https://bitbucket.org/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users"
}
},
"nickname": "Nickname",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"type": "project",
"updated_on": "2022-08-24T09:25:07.11111111+00:00",
"uuid": "{11111111-1111-1111-1111-111111111111}",
"workspace": {
"links": {
"avatar": {
"href": "https://bitbucket.org/workspaces/workspace/avatar/?ts=11111111"
},
"html": {
"href": "https://bitbucket.org/workspace/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/workspaces/workspace"
}
},
"name": "Name",
"slug": "name",
"type": "workspace",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
{
"created_on": "2022-08-21T13:19:18.1111111+00:00",
"description": null,
"has_publicly_visible_repos": false,
"is_private": false,
"key": "TES",
"links": {
"avatar": {
"href": "https://bitbucket.org/account/user/workspace/projects/TES/avatar/11?ts=11111111"
},
"html": {
"href": "https://bitbucket.org/workspace/workspace/projects/TES"
},
"repositories": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace?q=project.key=\"TES\""
},
"self": {
"href": "https://api.bitbucket.org/2.0/workspaces/workspace/projects/TES"
}
},
"name": "testId",
"owner": {
"account_id": "111111111111111111111111",
"display_name": "Display Name",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/1111111111111?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net1111.png"
},
"html": {
"href": "https://bitbucket.org/%11111111-1111-1111-1111-11111111111%11"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/"
}
},
"nickname": "nickname",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"type": "project",
"updated_on": "2022-08-21T13:19:18.111111+00:00",
"uuid": "{11111111-1111-1111-1111-111111111111}",
"workspace": {
"links": {
"avatar": {
"href": "https://bitbucket.org/workspaces/workspace/avatar/?ts=11111111"
},
"html": {
"href": "https://bitbucket.org/workspace/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/workspaces/workspace"
}
},
"name": "Name",
"slug": "name",
"type": "workspace",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
}
]
}
}

Human Readable Output#

List of projects in workspace#

KeyNameDescriptionIsPrivate
APAnother Projectdescriptiontrue
TEStestIdfalse

bitbucket-open-branch-list#


Returns a list of the open branches.

Base Command#

bitbucket-open-branch-list

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
limitThe maximum number of items in the list. The default value is 50.Optional
pageThe specific result page to display.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.Branch.nameStringThe branch name.
Bitbucket.Branch.target.typeStringThe type of the last action in the branch.
Bitbucket.Branch.target.hashStringThe hash of the last action in the branch.
Bitbucket.Branch.target.dateDateThe creation date of the last action in the branch.
Bitbucket.Branch.target.author.typeStringThe type of the author of the last action.
Bitbucket.Branch.target.author.rawStringThe raw information about the author of the last action.
Bitbucket.Branch.target.author.user.display_nameStringThe display name of the author of the last action.
Bitbucket.Branch.target.author.user.linksStringLinks to information about the user.
Bitbucket.Branch.target.author.user.typeStringThe user type of the user who made the last action in the branch.
Bitbucket.Branch.target.author.user.uuidStringThe unique user ID of the user who made the last action in the branch.
Bitbucket.Branch.target.author.user.account_idStringThe account ID of the user who made the last action in the branch.
Bitbucket.Branch.target.author.user.nicknameStringThe nickname of the user who made the last action in the branch.
Bitbucket.Branch.target.messageStringThe message assigned to the last action in the branch.
Bitbucket.Branch.target.linksStringThe links associated with this command.
Bitbucket.Branch.target.parents.typeStringThe type of the parent who created the branch.
Bitbucket.Branch.target.parents.hashStringThe hash of the parent who created the branch.
Bitbucket.Branch.target.parents.linksStringThe links associated with the parents of the command.
Bitbucket.Branch.target.repository.typeStringThe repository type.
Bitbucket.Branch.target.repository.full_nameStringThe full name of the repository.
Bitbucket.Branch.target.repository.linksStringLinks with information about the relevant repository.
Bitbucket.Branch.target.repository.nameStringThe name of the repository
Bitbucket.Branch.target.repository.uuidStringThe repository unique ID.
Bitbucket.Branch.linksStringLinks with information about the branch.
Bitbucket.Branch.typeStringThe type of the branch.
Bitbucket.Branch.merge_strategiesStringThe merge strategy of the branch.
Bitbucket.Branch.default_merge_strategyStringThe default merge strategy in the branch.

Command example#

!bitbucket-open-branch-list

Context Example#

{
"Bitbucket": {
"Branch": [
{
"default_merge_strategy": "merge_commit",
"links": {
"commits": {
"href": "https://api.bitbucket.org/2.0/repositories/workspae/start_repo/commits/master"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/branch/master"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/refs/branches/master"
}
},
"merge_strategies": [
"merge_commit",
"squash",
"fast_forward"
],
"name": "master",
"target": {
"author": {
"raw": "Some User <someuser@gmail.com>",
"type": "author",
"user": {
"account_id": "11111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%1111%.png"
},
"html": {
"href": "https://bitbucket.org/111111111/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/11111111111"
}
},
"nickname": "nickname",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"date": "2022-09-18T08:00:00+00:00",
"hash": "1111111111111111111111111111111111111111",
"links": {
"approve": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/approve"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/comments"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diff/1111111111111111111111111111111111111111"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/patch/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
},
"statuses": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/statuses"
}
},
"message": "delete the new file",
"parents": [
{
"hash": "1111111111111111111111111111111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
}
},
"type": "commit"
}
],
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%11111111-1111-1111-1111-11111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"type": "commit"
},
"type": "branch"
},
{
"default_merge_strategy": "merge_commit",
"links": {
"commits": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commits/branch"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/branch/branch"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/refs/branches/branch"
}
},
"merge_strategies": [
"merge_commit",
"squash",
"fast_forward"
],
"name": "branch",
"target": {
"author": {
"raw": "Some User <someuser@gmail.com>",
"type": "author",
"user": {
"account_id": "1111111111111111111111",
"display_name": "Display Name",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/avatar-management--avatars.us-west-2.prod.public.atl-paas.net%1Finitials%1111-1.png"
},
"html": {
"href": "https://bitbucket.org/%11111111111%11/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%11111111-1111-1111-1111-111111111%11"
}
},
"nickname": "nickname",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"date": "2022-09-08T00:00:00+00:00",
"hash": "1111111111111111111111111111111111111111",
"links": {
"approve": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/approve"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/comments"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diff/1111111111111111111111111111111111111111"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/patch/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
},
"statuses": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/statuses"
}
},
"message": "something",
"parents": [
{
"hash": "1111111111111111111111111111111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
}
},
"type": "commit"
}
],
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%111111111-1111-1111-1111-1111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"type": "commit"
},
"type": "branch"
}
]
}
}

Human Readable Output#

Open Branches#

NameLastCommitCreatedByLastCommitCreatedAtLastCommitHash
masterSome User2022-09-18T08:00:00+00:001111111111111111111111111111111111111111
branchSome User2022-09-08T14:00:00+00:001111111111111111111111111111111111111111

bitbucket-branch-get#


Returns the information of the requested branch.

Base Command#

bitbucket-branch-get

Input#

Argument NameDescriptionRequired
repoThe repository name. Should be given here or in the instance arguments.Optional
branch_nameThe name of the branch for which to retrieve the information.Required
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.Branch.nameStringThe name of the branch.
Bitbucket.Branch.target.typeStringThe last action type.
Bitbucket.Branch.target.hashStringThe hash of the last action in the branch.
Bitbucket.Branch.target.dateDateThe date of the last action in the branch.
Bitbucket.Branch.target.author.typeStringThe type of the author.
Bitbucket.Branch.target.author.rawStringThe raw information about the author of the last action in the branch.
Bitbucket.Branch.target.author.user.display_nameStringThe display name of the author of the last action in the branch.
Bitbucket.Branch.target.author.user.linksStringLinks about the author of the last action in the branch.
Bitbucket.Branch.target.author.user.typeStringThe user type of the author of the last action in the branch.
Bitbucket.Branch.target.author.user.uuidStringThe unique universal ID of the author of the last action in the branch.
Bitbucket.Branch.target.author.user.account_idStringThe account ID of the author of the last action in the branch.
Bitbucket.Branch.target.author.user.nicknameStringThe nickname of the author of the last action in the branch.
Bitbucket.Branch.target.messageStringThe message associated with the last action in the branch.
Bitbucket.Branch.target.linksStringThe links of the last action in the branch.
Bitbucket.Branch.target.parents.typeStringThe type of the parents of the last action in the branch.
Bitbucket.Branch.target.parents.hashStringThe hash of the parents of the last action in the branch.
Bitbucket.Branch.target.parents.linksStringThe link associated with the parents of the last action in the branch.
Bitbucket.Branch.target.repository.typeStringThe type of the branch repository.
Bitbucket.Branch.target.repository.full_nameStringThe name of the branch repository.
Bitbucket.Branch.target.repository.linksStringLinks with information about the branch repository.
Bitbucket.Branch.target.repository.nameStringThe name of the repository.
Bitbucket.Branch.target.repository.uuidStringThe unique ID of the repository.
Bitbucket.Branch.linksStringLinks with information about the branch.
Bitbucket.Branch.typeStringThe type of the branch.
Bitbucket.Branch.merge_strategiesStringThe merge strategy of the branch.
Bitbucket.Branch.default_merge_strategyStringThe default merge strategy.

Command example#

!bitbucket-branch-get branch_name=master

Context Example#

{
"Bitbucket": {
"Branch": {
"default_merge_strategy": "merge_commit",
"links": {
"commits": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commits/master"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/branch/master"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/refs/branches/master"
}
},
"merge_strategies": [
"merge_commit",
"squash",
"fast_forward"
],
"name": "master",
"target": {
"author": {
"raw": "Some user <someuser@gmail.com>",
"type": "author",
"user": {
"account_id": "1111111111111111111111",
"display_name": "Display Name",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net%11initials%1111-1.png"
},
"html": {
"href": "https://bitbucket.org/%11111111-1111-1111-1111-11111111111%11/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%11111111-1111-1111-1111-11111111111%11"
}
},
"nickname": "nickname",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"date": "2022-09-18T00:00:00+00:00",
"hash": "1111111111111111111111111111111111111111",
"links": {
"approve": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/approve"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/comments"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diff/1111111111111111111111111111111111111111"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/patch/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
},
"statuses": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/statuses"
}
},
"message": "delete the new file",
"parents": [
{
"hash": "1111111111111111111111111111111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
}
},
"type": "commit"
}
],
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%11111111-1111-1111-1111-11111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"type": "commit"
},
"type": "branch"
}
}
}

Human Readable Output#

Information about the branch: master#

NameLastCommitCreatedAtLastCommitHash
masterSome User2022-09-18T08:07:00+00:00

bitbucket-branch-create#


Creates a new branch in Bitbucket.

Base Command#

bitbucket-branch-create

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
nameThe name of the new branch.Required
target_branchThe name of the branch from which the new branch will be created.Required
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.Branch.nameStringThe name of the new branch.
Bitbucket.Branch.target.typeStringThe type of the last action in the target branch.
Bitbucket.Branch.target.hashStringThe hash of the last action in the target branch.
Bitbucket.Branch.target.dateDateThe date of the last action in the target branch.
Bitbucket.Branch.target.author.typeStringThe type of the author of the last action in the target branch.
Bitbucket.Branch.target.author.rawStringThe raw information about the author of the last action in the target branch.
Bitbucket.Branch.target.author.user.display_nameStringThe display name of the author of the last action in the target branch.
Bitbucket.Branch.target.author.user.linksStringThe links with the information about the author of the last action in the target branch.
Bitbucket.Branch.target.author.user.typeStringThe user type of the author of the last action in the target branch.
Bitbucket.Branch.target.author.user.uuidStringThe unique ID of the author of the last action in the target branch.
Bitbucket.Branch.target.author.user.account_idStringThe account ID of the author of the last action in the target branch.
Bitbucket.Branch.target.author.user.nicknameStringThe nickname of the author of the last action in the target branch.
Bitbucket.Branch.target.messageStringThe message in the last action in the target branch.
Bitbucket.Branch.target.linksStringThe links with the information about the target branch.
Bitbucket.Branch.target.parents.typeStringThe type of the parent action of the last action in the target branch.
Bitbucket.Branch.target.parents.hashStringThe hash of the parent action of the last action in the target branch.
Bitbucket.Branch.target.parents.linksStringThe links associated with the parents of the command.
Bitbucket.Branch.target.repository.typeStringThe type of the repository of the target branch.
Bitbucket.Branch.target.repository.full_nameStringThe full name of the repository of the target branch.
Bitbucket.Branch.target.repository.linksStringThe links with the information about the repository of the target branch.
Bitbucket.Branch.target.repository.nameStringThe name of the repository of the target branch.
Bitbucket.Branch.target.repository.uuidStringThe unique ID of the repository of the target branch.
Bitbucket.Branch.linksStringThe links with the information about the new branch.
Bitbucket.Branch.typeStringThe type of the new branch.
Bitbucket.Branch.merge_strategiesStringThe merge strategies of the new branch.
Bitbucket.Branch.default_merge_strategyStringThe default merge strategy in the new branch.

Command example#

!bitbucket-branch-create name=testing target_branch=master

Context Example#

{
"Bitbucket": {
"Branch": {
"default_merge_strategy": "merge_commit",
"links": {
"commits": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commits/testing"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/branch/testing"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/refs/branches/testing"
}
},
"merge_strategies": [
"merge_commit",
"squash",
"fast_forward"
],
"name": "testing",
"target": {
"author": {
"raw": "Some User <someuser@gmail.com>",
"type": "author",
"user": {
"account_id": "1111111111111111111111",
"display_name": "Some user",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=https1avatar-management--avatars.us-west-2.prod.public.atl-paas.net%initials%1111-1.png"
},
"html": {
"href": "https://bitbucket.org/%11111111-1111-1111-1111-111111111111%11/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%11111111-1111-1111-1111-1111111111%11"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"date": "2022-09-18T08:00:00+00:00",
"hash": "1111111111111111111111111111111111111111",
"links": {
"approve": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/approve"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/comments"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diff/1111111111111111111111111111111111111111"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/patch/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
},
"statuses": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/statuses"
}
},
"message": "delete the new file",
"parents": [
{
"hash": "1111111111111111111111111111111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
}
},
"type": "commit"
}
],
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"type": "commit"
},
"type": "branch"
}
}
}

Human Readable Output#

The branch "testing" was created successfully.

bitbucket-branch-delete#


Deletes the given branch from Bitbucket.

Base Command#

bitbucket-branch-delete

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
branch_nameThe name of the branch to delete.Required

Context Output#

There is no context output for this command.

Command example#

!bitbucket-branch-delete branch_name=testing

Human Readable Output#

The branch testing was deleted successfully.

bitbucket-commit-create#


Creates a new commit in Bitbucket.

Base Command#

bitbucket-commit-create

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
messageCommit a message with the file.Required
branchThis branch will be associated with the committed file.Required
file_nameThe name of the file to commit.Optional
file_contentThe content of the file to commit.Optional
entry_idThe entry_id of the file to commit. This is the EntryId from uploading a file to the War Room.Optional
author_nameThe name of the author of the file.Optional
author_emailThe email of the author of the file.Optional

Context Output#

There is no context output for this command.

Command example#

!bitbucket-commit-create branch=master message="checking master" file_name="new_file.txt" file_content="some new content"

Human Readable Output#

The commit was created successfully.

bitbucket-commit-list#


Returns a list of the commit in accordance with the included and excluded branches.

Base Command#

bitbucket-commit-list

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
file_pathWill limit the results to commits that affect that path.Optional
excluded_branchesA comma-separated list of branches to exclude from the commits that are returned.Optional
included_branchesA comma-separated list of branches to include in the commits that are returned.Optional
limitThe maximum number of items in the list. The default value is 50.Optional
pageThe specific result page to display.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.Commit.typeStringThe type of the commit.
Bitbucket.Commit.hashStringThe commit hash.
Bitbucket.Commit.dateDateThe creation date of the commit.
Bitbucket.Commit.author.typeStringThe type of the author.
Bitbucket.Commit.author.rawStringThe raw information about the author, including the display name and user email.
Bitbucket.Commit.author.user.display_nameStringThe display name of the author.
Bitbucket.Commit.author.user.linksStringLinks with information about the author.
Bitbucket.Commit.author.user.typeStringThe user type of the author.
Bitbucket.Commit.author.user.uuidStringThe user unique key of the author.
Bitbucket.Commit.author.user.account_idStringThe user account ID of the author.
Bitbucket.Commit.author.user.nicknameStringThe user nickname of the author.
Bitbucket.Commit.messageStringThe commit message.
Bitbucket.Commit.summary.typeStringThe type of the summary.
Bitbucket.Commit.summary.rawStringThe raw summary of the commit.
Bitbucket.Commit.summary.markupStringThe text styling type, such as markdown.
Bitbucket.Commit.summary.htmlStringThe summary in HTML format.
Bitbucket.Commit.linksStringLinks with information about the commit.
Bitbucket.Commit.parents.typeStringThe type of the commit parents.
Bitbucket.Commit.parents.hashStringThe hash of the commit parents.
Bitbucket.Commit.parents.linksStringLinks with information about the parents.
Bitbucket.Commit.repository.typeStringThe type of the repository.
Bitbucket.Commit.repository.full_nameStringThe full name of the repository.
Bitbucket.Commit.repository.links.self.hrefStringLinks with information about the repository.
Bitbucket.Commit.repository.nameStringThe name of the repository.
Bitbucket.Commit.repository.uuidStringThe unique ID of the repository.

Command example#

!bitbucket-commit-list limit=2

Context Example#

{
"Bitbucket": {
"Commit": [
{
"author": {
"raw": "Some User <someuser@gmail.com>",
"type": "author",
"user": {
"account_id": "111111111111",
"display_name": "Display Name",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/111111111111111111111111111?d=httpsFavatar-management--avatars.us-west-2.prod.public.atl-paas.net%initials%1111-1.png"
},
"html": {
"href": "https://bitbucket.org/%11111111-1111-1111-1111-111111111111%11/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%11111111-1111-1111-1111-111111111111%11"
}
},
"nickname": "nickname",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"date": "2022-09-18T08:00:00+00:00",
"hash": "1111111111111111111111111111111111111111",
"links": {
"approve": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/approve"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/comments"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diff/1111111111111111111111111111111111111111"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/patch/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
},
"statuses": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/statuses"
}
},
"message": "checking master",
"parents": [
{
"hash": "1111111111111111111111111111111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
}
},
"type": "commit"
}
],
"rendered": {
"message": {
"html": "<p>checking master</p>",
"markup": "markdown",
"raw": "checking master",
"type": "rendered"
}
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-1111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"summary": {
"html": "<p>checking master</p>",
"markup": "markdown",
"raw": "checking master",
"type": "rendered"
},
"type": "commit"
},
{
"author": {
"raw": "Some User <someuser@gmail.com>",
"type": "author",
"user": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsFavatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%1111-1.png"
},
"html": {
"href": "https://bitbucket.org/%%11/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%%11"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"date": "2022-09-18T08:07:38+00:00",
"hash": "1111111111111111111111111111111111111111",
"links": {
"approve": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/approve"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/comments"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diff/1111111111111111111111111111111111111111"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"patch": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/patch/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
},
"statuses": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111/statuses"
}
},
"message": "delete the new file",
"parents": [
{
"hash": "1111111111111111111111111111111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/1111111111111111111111111111111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/1111111111111111111111111111111111111111"
}
},
"type": "commit"
}
],
"rendered": {
"message": {
"html": "<p>delete the new file</p>",
"markup": "markdown",
"raw": "delete the new file",
"type": "rendered"
}
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%7D?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"summary": {
"html": "<p>delete the new file</p>",
"markup": "markdown",
"raw": "delete the new file",
"type": "rendered"
},
"type": "commit"
}
]
}
}

Human Readable Output#

The list of commits#

AuthorCommitMessageCreatedAt
Some User someuser@gmail.com1111111111111111111111111111111111111111checking master2022-09-18T08:56:51+00:00
Some User someuser@gmail.com1111111111111111111111111111111111111111delete the new file2022-09-18T08:07:38+00:00

bitbucket-file-delete#


Deletes the given file from Bitbucket.

Base Command#

bitbucket-file-delete

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
messageCommit a message with the file.Required
branchThe branch of the file to delete.Required
file_nameThe name of the file to delete.Required
author_nameThe name of the author of the file.Optional
author_emailThe email of the author of the file.Optional

Context Output#

There is no context output for this command.

Command example#

!bitbucket-file-delete branch=master file_name=new_file.txt message="delete the new file"

Human Readable Output#

The file was deleted successfully.

bitbucket-raw-file-get#


Returns the content of the given file, along with the option to download it.

Base Command#

bitbucket-raw-file-get

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
file_pathThe path of the needed file.Required
branchThe branch of the file. If a branch isn't given, by default the command will return the content of the last edited file with the same file_path.Optional

Context Output#

PathTypeDescription
Bitbucket.RawFile.file_pathStringThe path of the file.
Bitbucket.RawFile.file_contentStringThe content of the file.
InfoFile.SizeNumberThe size of the file.
InfoFile.NameStringThe name of the file.
InfoFile.EntryIDStringThe entry ID of the file.
InfoFile.InfoStringFile information.
InfoFile.TypeStringThe file type.

Command example#

!bitbucket-raw-file-get file_path=new.txt branch=branch

Context Example#

{
"Bitbucket": {
"RawFile": {
"file_content":"Hi I am a new file.",
"file_path": "new.txt"
}
},
"File": {
"EntryID": "111111111111-1111-1111-1111-111111111111",
"Extension": "txt",
"Info": "txt",
"MD5": "11111111111111111111111111111111",
"Name": "new.txt",
"SHA1": "1111111111111111111111111111111111111111",
"SHA256": "111111111111111111111111111111111111111111111111111111111111111111",
"SHA512": "11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
"SSDeep": "11:1111111111111111111111111111111111111111111111111111111111111111111111111111111111",
"Size": 19,
"Type": "text/plain; charset=utf-8"
}
}

Human Readable Output#

The content of the file "new.txt" is: Hi I am a new file.

bitbucket-issue-create#


Creates an issue in Bitbucket.

Required Permissions#

In order to perform this command, please create an issue tracker by clicking on the relevant repo -> Repository settings -> Issue tracker

Base Command#

bitbucket-issue-create

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
titleThe title of the new issue.Required
stateThe state of the issues to create. Possible values are: new, open, resolved, on hold, invalid, duplicate, wontfix, closed. Default is new.Optional
typeThe type of the issues to create. Possible values are: bug, enhancement, proposal, task. Default is bug.Optional
priorityThe priority of the issues to create. Possible values are: trivial, minor, major, critical, blocker. Default is major.Optional
contentThe content of the issue to create.Optional
assignee_idThe ID of the assignee of the issue to create. To get the assignee_id, use the !bitbucket-workspace-member-list command, and use the field AccountId.Optional
assignee_user_nameThe user name of the assignee of the issue to create.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.Issue.typeStringThe action type.
Bitbucket.Issue.idNumberThe ID of the issue.
Bitbucket.Issue.repository.typeStringThe type of the repository.
Bitbucket.Issue.repository.full_nameStringThe full name of the repository.
Bitbucket.Issue.repository.linksStringLinks with information about the repository related to the issue.
Bitbucket.Issue.repository.nameStringThe name of the repository.
Bitbucket.Issue.repository.uuidStringThe unique ID of the repository.
Bitbucket.Issue.links.self.hrefStringAn API link to the issue.
Bitbucket.Issue.titleStringThe title of the issue
Bitbucket.Issue.content.typeStringThe type of the content.
Bitbucket.Issue.content.rawStringThe content of the issue.
Bitbucket.Issue.content.markupStringThe type of markup (like markdown).
Bitbucket.Issue.content.htmlStringThe content of the issue in HTML format.
Bitbucket.Issue.reporter.display_nameStringThe display name of the reporter of the issue.
Bitbucket.Issue.reporter.linksStringLinks with information about the reporter.
Bitbucket.Issue.reporter.typeStringThe type of the reporter.
Bitbucket.Issue.reporter.uuidStringThe unique ID of the reporter
Bitbucket.Issue.reporter.account_idStringThe account ID of the reporter.
Bitbucket.Issue.reporter.nicknameStringThe nickname of the reporter.
Bitbucket.Issue.assignee.display_nameStringThe display name of the assignee to the issue.
Bitbucket.Issue.assignee.linksStringLinks with information about the assignee.
Bitbucket.Issue.assignee.typeStringThe type of the assignee.
Bitbucket.Issue.assignee.uuidStringThe unique ID of the assignee.
Bitbucket.Issue.assignee.account_idStringThe account ID of the assignee.
Bitbucket.Issue.assignee.nicknameStringThe nickname of the assignee.
Bitbucket.Issue.created_onStringThe creation date of the issue.
Bitbucket.Issue.edited_onUnknownThe edit date of the issue.
Bitbucket.Issue.updated_onStringThe update date of the issue.
Bitbucket.Issue.stateStringThe state of the issue.
Bitbucket.Issue.kindStringThe kind of the issue.
Bitbucket.Issue.milestoneUnknownThe milestones in the issue.
Bitbucket.Issue.componentUnknownThe different components of the issue.
Bitbucket.Issue.priorityStringThe priority of the issue.
Bitbucket.Issue.versionUnknownThe version of the issue.
Bitbucket.Issue.votesNumberThe votes of approval of the issue.
Bitbucket.Issue.watchesUnknownThe watchers of the issue.

Command example#

!bitbucket-issue-create title="a new issue"

Context Example#

{
"Bitbucket": {
"Issue": {
"assignee": null,
"component": null,
"content": {
"html": "",
"markup": "markdown",
"raw": "",
"type": "rendered"
},
"created_on": "2022-09-18T08:00:00.000000+00:00",
"edited_on": null,
"id": 92,
"kind": "bug",
"links": {
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/92"
}
},
"milestone": null,
"priority": "major",
"reporter": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%1111-1.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"state": "new",
"title": "a new issue",
"type": "issue",
"updated_on": "2022-09-18T08:00:00.000000+00:00",
"version": null,
"votes": 0,
"watches": null
}
}
}

Human Readable Output#

The issue "a new issue" was created successfully

bitbucket-issue-list#


If an issue_id is given, returns the information about it. Otherwise, returns a list of all the issues, according to the limit parameter.

Base Command#

bitbucket-issue-list

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
issue_idThe ID of the requested issue. To get the issue_id, use the !bitbucket-issue-list command.Optional
limitThe maximum number of items in the list. The default value is 50.Optional
pageThe specific result page to display.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.Issue.typeStringThe action type.
Bitbucket.Issue.idNumberThe ID of the issue.
Bitbucket.Issue.repository.typeStringThe type of the repository.
Bitbucket.Issue.repository.full_nameStringThe full name of the repository.
Bitbucket.Issue.repository.linksStringLinks with information about the repository related to the issue.
Bitbucket.Issue.repository.nameStringThe name of the repository.
Bitbucket.Issue.repository.uuidStringThe unique ID of the repository.
Bitbucket.Issue.linksStringLinks with information about the issue.
Bitbucket.Issue.titleStringThe title of the issue.
Bitbucket.Issue.content.typeStringThe type of the content.
Bitbucket.Issue.content.rawStringThe content of the issue.
Bitbucket.Issue.content.markupStringThe type of markup (like markdown).
Bitbucket.Issue.content.htmlStringThe content of the issue in HTML format.
Bitbucket.Issue.reporter.display_nameStringThe display name of the reporter of the issue.
Bitbucket.Issue.reporter.linksStringLinks with information about the reporter.
Bitbucket.Issue.reporter.typeStringThe type of the reporter.
Bitbucket.Issue.reporter.uuidStringThe unique ID of the reporter
Bitbucket.Issue.reporter.account_idStringThe account ID of the reporter.
Bitbucket.Issue.reporter.nicknameStringThe nickname of the reporter.
Bitbucket.Issue.assignee.display_nameStringThe display name of the assignee to the issue.
Bitbucket.Issue.assignee.linksStringLinks with information about the assignee.
Bitbucket.Issue.assignee.typeStringThe type of the assignee.
Bitbucket.Issue.assignee.uuidStringThe unique ID of the assignee.
Bitbucket.Issue.assignee.account_idStringThe account ID of the assignee.
Bitbucket.Issue.assignee.nicknameStringThe nickname of the assignee.
Bitbucket.Issue.created_onStringThe creation date of the issue.
Bitbucket.Issue.edited_onUnknownThe edit date of the issue.
Bitbucket.Issue.updated_onStringThe update date of the issue.
Bitbucket.Issue.stateStringThe state ID of the issue.
Bitbucket.Issue.kindStringThe kind of the issue.
Bitbucket.Issue.milestoneUnknownThe milestones in the issue.
Bitbucket.Issue.componentUnknownThe different components of the issue.
Bitbucket.Issue.priorityStringThe priority of the issue.
Bitbucket.Issue.versionUnknownThe version of the issue.
Bitbucket.Issue.votesNumberThe votes of approval of the issue.
Bitbucket.Issue.watchesNumberThe watchers of the issue.

Command example#

!bitbucket-issue-list limit=2

Context Example#

{
"Bitbucket": {
"Issue": [
{
"assignee": null,
"component": null,
"content": {
"html": "",
"markup": "markdown",
"raw": "",
"type": "rendered"
},
"created_on": "2022-09-18T08:00:00.000000+00:00",
"edited_on": null,
"id": 92,
"kind": "bug",
"links": {
"attachments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/92/attachments"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/92/comments"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/issues/92/a-new-issue"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/92"
},
"vote": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/92/vote"
},
"watch": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/92/watch"
}
},
"milestone": null,
"priority": "major",
"reporter": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net%1Finitials%1111-1.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"state": "new",
"title": "a new issue",
"type": "issue",
"updated_on": "2022-09-18T08:57:05.560996+00:00",
"version": null,
"votes": 0,
"watches": 1
},
{
"assignee": null,
"component": null,
"content": {
"html": "",
"markup": "markdown",
"raw": "",
"type": "rendered"
},
"created_on": "2022-09-18T08:00:00.000000+00:00",
"edited_on": null,
"id": 91,
"kind": "bug",
"links": {
"attachments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/91/attachments"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/91/comments"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/issues/91/a-new-issue"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/91"
},
"vote": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/91/vote"
},
"watch": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/91/watch"
}
},
"milestone": null,
"priority": "major",
"reporter": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net%initials%1111-1.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"state": "resolved",
"title": "a new issue",
"type": "issue",
"updated_on": "2022-09-18T08:00:00.000000+00:00",
"version": null,
"votes": 0,
"watches": 1
}
]
}
}

Human Readable Output#

Issues List#

IdTitleTypePriorityStatusVotesCreatedAtUpdatedAt
92a new issuebugmajornew02022-09-18T08:00:00.000000+00:002022-09-18T08:00:00.000000+00:00
91a new issuebugmajorresolved02022-09-18T08:00:00.000000+00:002022-09-18T08:00:00.000000+00:00

bitbucket-issue-update#


Updates an issue in Bitbucket.

Required Permissions#

In order to perform this command, please create an issue tracker by clicking on the relevant repo -> Repository settings -> Issue tracker.

Base Command#

bitbucket-issue-update

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
titleThe title of the new issue.Required
issue_idThe ID of the issue to update. To get the issue_id, use the !bitbucket-issue-list command.Required
stateThe state of the issues to create. Possible values are: new, open, resolved, on hold, invalid, duplicate, wontfix, closed.Optional
typeThe type of the issues to create. Possible values are: bug, enhancement, proposal, task.Optional
priorityThe priority of the issues to create. Possible values are: trivial, minor, major, critical, blocker.Optional
contentThe content of the issue to create.Optional
assignee_idThe ID of the assignee of the issue to create. To get the assignee_id, use the !bitbucket-workspace-member-list command, and use the field AccountId.Optional
assignee_user_nameThe user name of the assignee of the issue to create.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.Issue.typeStringThe action type.
Bitbucket.Issue.idNumberThe ID of the issue.
Bitbucket.Issue.repository.typeStringThe type of the repository.
Bitbucket.Issue.repository.full_nameStringThe full name of the repository.
Bitbucket.Issue.repository.linksStringLinks with information about the repository related to the issue.
Bitbucket.Issue.repository.nameStringThe name of the repository.
Bitbucket.Issue.repository.uuidStringThe unique ID of the repository.
Bitbucket.Issue.linksStringLinks with information about the issue.
Bitbucket.Issue.titleStringThe title of the issue.
Bitbucket.Issue.content.typeStringThe type of the content.
Bitbucket.Issue.content.rawStringThe content of the issue.
Bitbucket.Issue.content.markupStringThe type of markup (like markdown).
Bitbucket.Issue.content.htmlStringThe content of the issue in HTML format.
Bitbucket.Issue.reporter.display_nameStringThe display name of the reporter of the issue.
Bitbucket.Issue.reporter.linksStringLinks with information about the reporter.
Bitbucket.Issue.reporter.typeStringThe type of the reporter.
Bitbucket.Issue.reporter.uuidStringThe unique ID of the reporter.
Bitbucket.Issue.reporter.account_idStringThe account ID of the reporter.
Bitbucket.Issue.reporter.nicknameStringThe nickname of the reporter.
Bitbucket.Issue.assignee.display_nameStringThe display name of the assignee to the issue.
Bitbucket.Issue.assignee.linksStringLinks with information about the assignee.
Bitbucket.Issue.assignee.typeStringThe type of the assignee.
Bitbucket.Issue.assignee.uuidStringThe unique ID of the assignee.
Bitbucket.Issue.assignee.account_idStringThe account ID of the assignee.
Bitbucket.Issue.assignee.nicknameStringThe nickname of the assignee.
Bitbucket.Issue.created_onStringThe creation date of the issue.
Bitbucket.Issue.edited_onUnknownThe edit date of the issue.
Bitbucket.Issue.updated_onStringThe update date of the issue.
Bitbucket.Issue.stateStringThe state ID of the issue.
Bitbucket.Issue.kindStringThe kind of the issue.
Bitbucket.Issue.milestoneUnknownThe milestones in the issue.
Bitbucket.Issue.componentUnknownThe different components of the issue.
Bitbucket.Issue.priorityStringThe priority of the issue.
Bitbucket.Issue.versionUnknownThe version of the issue.
Bitbucket.Issue.votesNumberThe votes of approval of the issue.
Bitbucket.Issue.watchesNumberThe watchers of the issue.

Command example#

!bitbucket-issue-update issue_id=91 title="a new issue" state=resolved

Context Example#

{
"Bitbucket": {
"Issue": {
"assignee": null,
"component": null,
"content": {
"html": "",
"markup": "markdown",
"raw": "",
"type": "rendered"
},
"created_on": "2022-09-18T08:00:00.000000+00:00",
"edited_on": null,
"id": 91,
"kind": "bug",
"links": {
"attachments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/91/attachments"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/91/comments"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/issues/91/a-new-issue"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/91"
},
"vote": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/91/vote"
},
"watch": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/91/watch"
}
},
"milestone": null,
"priority": "major",
"reporter": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net%Finitials%1111-1.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"state": "resolved",
"title": "a new issue",
"type": "issue",
"updated_on": "2022-09-18T08:00:00.000000+00:00",
"version": null,
"votes": 0,
"watches": 1
}
}
}

Human Readable Output#

The issue with id "91" was updated successfully

bitbucket-pull-request-create#


Creates a pull request in Bitbucket.

Base Command#

bitbucket-pull-request-create

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
titleThe title of the new pull request.Required
source_branchThe branch that contains the proposed changes.Required
destination_branchThe branch that will contain the changes after the merge process.Optional
reviewer_idA comma-separated list of account_ids of the person to review the pull request. To get the reviewer_id, use the !bitbucket-workspace-member-list command, and use the field AccountId.Optional
descriptionA description of the pull request.Optional
close_source_branchWhether the source branch should be closed after the pull request. Possible values are: yes, no.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.PullRequest.comment_countNumberThe number of comments there are in the pull request.
Bitbucket.PullRequest.task_countNumberThe number of tasks there are in the pull request.
Bitbucket.PullRequest.typeStringThe type of the request.
Bitbucket.PullRequest.idNumberThe pull request ID.
Bitbucket.PullRequest.titleStringThe title of the pull request.
Bitbucket.PullRequest.descriptionStringThe description of the pull request.
Bitbucket.PullRequest.rendered.title.typeStringThe type of the title of the request.
Bitbucket.PullRequest.rendered.title.rawStringThe content of the rendered title.
Bitbucket.PullRequest.rendered.title.markupStringThe text styling type, such as markdown.
Bitbucket.PullRequest.rendered.title.htmlStringThe HTML format of the pull request title.
Bitbucket.PullRequest.rendered.description.typeStringThe type of the pull request description
Bitbucket.PullRequest.rendered.description.rawStringThe content of the description of the pull request.
Bitbucket.PullRequest.rendered.description.markupStringThe text styling type, such as markdown.
Bitbucket.PullRequest.rendered.description.htmlStringHTML format of the description content.
Bitbucket.PullRequest.stateStringThe status of the pull request.
Bitbucket.PullRequest.merge_commitUnknownWhether it is a merge commit.
Bitbucket.PullRequest.close_source_branchBooleanWhether the branch should be closed after the merge.
Bitbucket.PullRequest.closed_byUnknownThe user who closed the pull request.
Bitbucket.PullRequest.author.display_nameStringThe display name of the author of the pull request.
Bitbucket.PullRequest.author.linksStringLinks with information about the author of the pull request.
Bitbucket.PullRequest.author.typeStringThe type of the author
Bitbucket.PullRequest.author.uuidStringThe unique universal ID of the author.
Bitbucket.PullRequest.author.account_idStringThe account ID of the author of the pull request.
Bitbucket.PullRequest.author.nicknameStringThe nickname of the author.
Bitbucket.PullRequest.reasonStringThe reason to create the request.
Bitbucket.PullRequest.created_onStringThe creation date of the request.
Bitbucket.PullRequest.updated_onStringThe date of the last update of the pull request.
Bitbucket.PullRequest.destination.branch.nameStringThe name of the destination branch. This is the branch to merge to.
Bitbucket.PullRequest.destination.commit.typeStringThe type of the commit.
Bitbucket.PullRequest.destination.commit.hashStringThe hash of the commit.
Bitbucket.PullRequest.destination.commit.linksStringLinks with information about the commit.
Bitbucket.PullRequest.destination.repository.typeStringThe type of the repository.
Bitbucket.PullRequest.destination.repository.full_nameStringThe full name of the repository of the destination branch.
Bitbucket.PullRequest.destination.repository.linksStringLinks with information about the repository of the destination branch.
Bitbucket.PullRequest.destination.repository.nameStringThe name of the repository.
Bitbucket.PullRequest.destination.repository.uuidStringThe unique ID of the repository.
Bitbucket.PullRequest.source.branch.nameStringThe name of the source branch. This is the branch with the changes that will be merged.
Bitbucket.PullRequest.source.commit.typeStringThe type of the commit in the source branch.
Bitbucket.PullRequest.source.commit.hashStringThe hash of the commit in the source branch
Bitbucket.PullRequest.source.commit.linksStringLinks with information about the commit in the source branch.
Bitbucket.PullRequest.source.repository.typeStringThe type of the repository of the source branch.
Bitbucket.PullRequest.source.repository.full_nameStringThe full name of the repository of the source branch.
Bitbucket.PullRequest.source.repository.links.self.hrefStringLinks with information about the repository of the source branch.
Bitbucket.PullRequest.source.repository.linksStringLinks with information about the repository of the source branch.
Bitbucket.PullRequest.source.repository.nameStringThe name of the repository of the source branch.
Bitbucket.PullRequest.source.repository.uuidStringThe unique ID of the repository of the source branch.
Bitbucket.PullRequest.reviewers.display_nameStringThe display name of the reviewer.
Bitbucket.PullRequest.reviewers.linksStringLinks with information about the reviewer.
Bitbucket.PullRequest.reviewers.typeStringThe type of the reviewer.
Bitbucket.PullRequest.reviewers.uuidStringThe unique id of the reviewer.
Bitbucket.PullRequest.reviewers.account_idStringThe account id of the reviewer.
Bitbucket.PullRequest.reviewers.nicknameStringThe nickname of the reviewer.
Bitbucket.PullRequest.participants.typeStringThe type of the participant.
Bitbucket.PullRequest.participants.user.display_nameStringThe display name of the participant.
Bitbucket.PullRequest.participants.user.linksStringLinks with information about the user.
Bitbucket.PullRequest.participants.user.typeStringThe type of the participant.
Bitbucket.PullRequest.participants.user.uuidStringThe unique id of the participant.
Bitbucket.PullRequest.participants.user.account_idStringThe account id of the participant.
Bitbucket.PullRequest.participants.user.nicknameStringThe nickname of the participant.
Bitbucket.PullRequest.participants.roleStringThe role of the participant.
Bitbucket.PullRequest.participants.approvedStringThe approval status of the pull request.
Bitbucket.PullRequest.participants.stateStringThe state of the participant.
Bitbucket.PullRequest.participants.participated_onUnknownThe date of participation.
Bitbucket.PullRequest.linksStringLinks to information about the pull request.
Bitbucket.PullRequest.summary.typeStringThe type of the pull request.
Bitbucket.PullRequest.summary.rawStringThe description of the pull request.
Bitbucket.PullRequest.summary.markupStringThe text styling type, such as markdown.
Bitbucket.PullRequest.summary.htmlStringThe description of the pull request in HTML format.

Command example#

!bitbucket-pull-request-create source_branch=test title="pull_request"

Context Example#

{
"Bitbucket": {
"PullRequest": {
"author": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net%Finitials%1111-1.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"close_source_branch": false,
"closed_by": null,
"comment_count": 12,
"created_on": "2022-09-12T09:00:00.000000+00:00",
"description": "",
"destination": {
"branch": {
"name": "master"
},
"commit": {
"hash": "111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/111111111111"
}
},
"type": "commit"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"id": 8,
"links": {
"activity": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/activity"
},
"approve": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/approve"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/comments"
},
"commits": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/commits"
},
"decline": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/decline"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diff/workspace/start_repo:0111111111111111111111111?from_pullrequest_id=8&topic=true"
},
"diffstat": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diffstat/workspace/start_repo:01111111111%0D111111111111?from_pullrequest_id=8&topic=true"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/pull-requests/8"
},
"merge": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/merge"
},
"request-changes": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/request-changes"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8"
},
"statuses": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/statuses"
}
},
"merge_commit": null,
"participants": [
{
"approved": false,
"participated_on": "2022-09-15T12:00:00.000000+00:00",
"role": "PARTICIPANT",
"state": null,
"type": "participant",
"user": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net%initials.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
}
],
"reviewers": [
{
"display_name": "Some User",
"links": {
"self": {
"href": "https://api.bitbucket.org/2.0/users/"
},
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/"
}
},
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}",
"account_id": "111111111111111111111111",
"nickname": "Some User"
}
],
"reason": "",
"rendered": {
"description": {
"html": "",
"markup": "markdown",
"raw": "",
"type": "rendered"
},
"title": {
"html": "<p>pull_request</p>",
"markup": "markdown",
"raw": "pull_request",
"type": "rendered"
}
},
"source": {
"branch": {
"name": "test"
},
"commit": {
"hash": "111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/111111111111"
}
},
"type": "commit"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"state": "OPEN",
"summary": {
"html": "",
"markup": "markdown",
"raw": "",
"type": "rendered"
},
"task_count": 0,
"title": "pull_request",
"type": "pullrequest",
"updated_on": "2022-09-18T08:00:00.000000+00:00"
}
}
}

Human Readable Output#

The pull request was created successfully

bitbucket-pull-request-update#


Updates a pull request in Bitbucket.

Base Command#

bitbucket-pull-request-update

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
pull_request_idThe ID of the pull request to update. To get the pull_request_id, use the !bitbucket-pull-request-list command.Required
titleThe title of the new pull request.Optional
source_branchThe branch that contains the proposed changes.Optional
destination_branchThe branch that will contain the changes after the merge process.Optional
reviewer_idThe ID of the account of the person to review the pull request. To get the reviewer_id, use the bitbucket-workspace-member-list command, and use the field AccountId.Optional
descriptionA description of the pull request.Optional
close_source_branchWhether the source branch should be closed after the pull request. Possible values are: yes, no.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.PullRequest.comment_countNumberThe number of comments in the pull request.
Bitbucket.PullRequest.task_countNumberThe number of tasks in the pull request.
Bitbucket.PullRequest.typeStringThe type of the request.
Bitbucket.PullRequest.idNumberThe pull request ID.
Bitbucket.PullRequest.titleStringThe title of the pull request.
Bitbucket.PullRequest.descriptionStringThe description of the pull request.
Bitbucket.PullRequest.rendered.title.typeStringThe type of the title of the request.
Bitbucket.PullRequest.rendered.title.rawStringThe content of the rendered title.
Bitbucket.PullRequest.rendered.title.markupStringThe text styling type, such as markdown.
Bitbucket.PullRequest.rendered.title.htmlStringThe HTML format of the pull request title.
Bitbucket.PullRequest.rendered.description.typeStringThe type of the pull request description.
Bitbucket.PullRequest.rendered.description.rawStringThe content of the description of the pull request.
Bitbucket.PullRequest.rendered.description.markupStringThe text styling type, such as markdown.
Bitbucket.PullRequest.rendered.description.htmlStringHTML format of the description content.
Bitbucket.PullRequest.stateStringThe status of the pull request.
Bitbucket.PullRequest.merge_commitUnknownWhether it is a merge commit.
Bitbucket.PullRequest.close_source_branchBooleanWhether the branch should be closed after the merge.
Bitbucket.PullRequest.closed_byUnknownThe user who closed the pull request.
Bitbucket.PullRequest.author.display_nameStringThe display name of the author of the pull request.
Bitbucket.PullRequest.author.linksStringLinks with information about the author of the pull request.
Bitbucket.PullRequest.author.typeStringThe type of the author.
Bitbucket.PullRequest.author.uuidStringThe unique universal ID of the author.
Bitbucket.PullRequest.author.account_idStringThe account ID of the author of the pull request.
Bitbucket.PullRequest.author.nicknameStringThe nickname of the author.
Bitbucket.PullRequest.reasonStringThe reason to create the request.
Bitbucket.PullRequest.created_onStringThe creation date of the request.
Bitbucket.PullRequest.updated_onStringThe date of the last update of the pull request.
Bitbucket.PullRequest.destination.branch.nameStringThe name of the destination branch. This is the branch to merge to.
Bitbucket.PullRequest.destination.commit.typeStringThe type of the commit.
Bitbucket.PullRequest.destination.commit.hashStringThe hash of the commit.
Bitbucket.PullRequest.destination.commit.linksStringLinks with information about the commit.
Bitbucket.PullRequest.destination.repository.typeStringThe type of the repository of the destination branch.
Bitbucket.PullRequest.destination.repository.full_nameStringThe full name of the repository of the destination branch.
Bitbucket.PullRequest.destination.repository.linksStringLinks with information about the repository of the destination branch.
Bitbucket.PullRequest.destination.repository.nameStringThe name of the repository of the destination branch.
Bitbucket.PullRequest.destination.repository.uuidStringThe unique ID of the repository of the destination branch.
Bitbucket.PullRequest.source.branch.nameStringThe name of the source branch. That is the branch with the changes that will be merged.
Bitbucket.PullRequest.source.commit.typeStringThe type of the commit in the source branch.
Bitbucket.PullRequest.source.commit.hashStringThe hash of the commit in the source branch.
Bitbucket.PullRequest.source.commit.linksStringLinks with information about the commit in the source branch.
Bitbucket.PullRequest.source.repository.typeStringThe type of the repository of the source branch.
Bitbucket.PullRequest.source.repository.full_nameStringThe full name of the repository of the source branch.
Bitbucket.PullRequest.source.repository.linksStringLinks with information about the repository of the source branch.
Bitbucket.PullRequest.source.repository.nameStringThe name of the repository of the source branch.
Bitbucket.PullRequest.source.repository.uuidStringThe unique ID of the repository of the source branch.
Bitbucket.PullRequest.reviewers.display_nameStringThe display name of the reviewer.
Bitbucket.PullRequest.reviewers.linksStringLinks with information about the reviewer.
Bitbucket.PullRequest.reviewers.typeStringThe type of the reviewer.
Bitbucket.PullRequest.reviewers.uuidStringThe unique id of the reviewer.
Bitbucket.PullRequest.reviewers.account_idStringThe account id of the reviewer.
Bitbucket.PullRequest.reviewers.nicknameStringThe nickname of the reviewer.
Bitbucket.PullRequest.participants.typeStringThe type of the participant.
Bitbucket.PullRequest.participants.user.display_nameStringThe display name of the participant.
Bitbucket.PullRequest.participants.user.linksStringLinks with information about the user.
Bitbucket.PullRequest.participants.user.typeStringThe type of the participant.
Bitbucket.PullRequest.participants.user.uuidStringThe unique id of the participant.
Bitbucket.PullRequest.participants.user.account_idStringThe account id of the participant.
Bitbucket.PullRequest.participants.user.nicknameStringThe nickname of the participant.
Bitbucket.PullRequest.participants.roleStringThe role of the participant.
Bitbucket.PullRequest.participants.approvedStringThe approval status of the pull request.
Bitbucket.PullRequest.participants.stateStringThe state of the participant.
Bitbucket.PullRequest.participants.participated_onStringThe date of participation.
Bitbucket.PullRequest.linksStringLinks to information about the pull request.
Bitbucket.PullRequest.summary.typeStringThe type of the pull request.
Bitbucket.PullRequest.summary.rawStringThe description of the pull request.
Bitbucket.PullRequest.summary.markupStringThe text styling type, such as markdown.
Bitbucket.PullRequest.summary.htmlStringThe description of the pull request in HTML format.

Command example#

!bitbucket-pull-request-update pull_request_id=8 description="updating description"

Context Example#

{
"Bitbucket": {
"PullRequest": {
"author": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net%Finitials%1111-1.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"close_source_branch": false,
"closed_by": null,
"comment_count": 12,
"created_on": "2022-09-12T09:00:00.000000+00:00",
"description": "updating description",
"destination": {
"branch": {
"name": "master"
},
"commit": {
"hash": "111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/111111111111"
}
},
"type": "commit"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"id": 8,
"links": {
"activity": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/activity"
},
"approve": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/approve"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/comments"
},
"commits": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/commits"
},
"decline": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/decline"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diff/workspace/start_repo:0111111111111111111111111?from_pullrequest_id=8&topic=true"
},
"diffstat": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diffstat/workspace/start_repo:01111111111%0D111111111111?from_pullrequest_id=8&topic=true"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/pull-requests/8"
},
"merge": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/merge"
},
"request-changes": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/request-changes"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8"
},
"statuses": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/statuses"
}
},
"merge_commit": null,
"participants": [
{
"approved": false,
"participated_on": "2022-09-15T12:00:00.000000+00:00",
"role": "PARTICIPANT",
"state": null,
"type": "participant",
"user": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net%initials.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
}
],
"reviewers": [
{
"display_name": "Some User",
"links": {
"self": {
"href": "https://api.bitbucket.org/2.0/users/"
},
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/"
}
},
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}",
"account_id": "111111111111111111111111",
"nickname": "Some User"
}
],
"reason": "",
"rendered": {
"description": {
"html": "<p>updating description</p>",
"markup": "markdown",
"raw": "updating description",
"type": "rendered"
},
"title": {
"html": "<p>pull_request</p>",
"markup": "markdown",
"raw": "pull_request",
"type": "rendered"
}
},
"source": {
"branch": {
"name": "test"
},
"commit": {
"hash": "111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/111111111111"
}
},
"type": "commit"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"state": "OPEN",
"summary": {
"html": "",
"markup": "markdown",
"raw": "",
"type": "rendered"
},
"task_count": 0,
"title": "pull_request",
"type": "pullrequest",
"updated_on": "2022-09-18T08:00:00.000000+00:00"
}
}
}

bitbucket-pull-request-list#


Returns a list of the pull requests. If a state is provided than the list will contain only PRs with the wanted status. If a state is not provided, by default a list of the open pull requests will return.

Base Command#

bitbucket-pull-request-list

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
pull_request_idThe ID of the pull request to update. To get the pull_request_id, use the !bitbucket-pull-request-list command.Optional
stateThe state of the pull requests to see. Possible values are: OPEN, MERGED, DECLINED, SUPERSEDED, ALL.Optional
limitThe maximum number of items in the list. The default value is 50.Optional
pageThe specific result page to display.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.PullRequest.comment_countNumberThe number of comments in the pull request.
Bitbucket.PullRequest.task_countNumberThe number of tasks in the pull request.
Bitbucket.PullRequest.typeStringThe type of the request.
Bitbucket.PullRequest.idNumberThe pull request ID.
Bitbucket.PullRequest.titleStringThe title of the pull request.
Bitbucket.PullRequest.descriptionStringThe description of the pull request.
Bitbucket.PullRequest.stateStringThe status of the pull request.
Bitbucket.PullRequest.merge_commit.typeStringThe type of the merge commit.
Bitbucket.PullRequest.merge_commit.hashStringThe hash of the merged commit.
Bitbucket.PullRequest.merge_commit.linksStringLinks with information about the merged commit.
Bitbucket.PullRequest.close_source_branchBooleanWhether the branch should be closed after the merge.
Bitbucket.PullRequest.closed_by.display_nameStringThe display name of the user who closed the pull request.
Bitbucket.PullRequest.closed_by.linksStringLinks with information about the user who closed the pull request.
Bitbucket.PullRequest.closed_by.typeStringThe type of user who closed the pull request.
Bitbucket.PullRequest.closed_by.uuidStringThe unique ID of the user who closed the pull request.
Bitbucket.PullRequest.closed_by.account_idStringThe account ID of the user who closed the pull request.
Bitbucket.PullRequest.closed_by.nicknameStringThe nickname of the user who closed the pull request.
Bitbucket.PullRequest.author.display_nameStringThe display name of the author of the pull request.
Bitbucket.PullRequest.author.links.self.hrefStringLinks with information about the author of the pull request.
Bitbucket.PullRequest.author.typeStringThe type of the author.
Bitbucket.PullRequest.author.uuidStringThe unique universal ID of the author.
Bitbucket.PullRequest.author.account_idStringThe account ID of the author of the pull request.
Bitbucket.PullRequest.author.nicknameStringThe nickname of the author.
Bitbucket.PullRequest.reasonStringThe reason to create the request.
Bitbucket.PullRequest.created_onStringThe creation date of the request.
Bitbucket.PullRequest.updated_onStringThe date of the last update of the pull request.
Bitbucket.PullRequest.destination.branch.nameStringThe name of the destination branch. That is the branch to merge to.
Bitbucket.PullRequest.destination.commit.typeStringThe type of the commit.
Bitbucket.PullRequest.destination.commit.hashStringThe hash of the commit.
Bitbucket.PullRequest.destination.commit.linksStringLinks with information about the commit.
Bitbucket.PullRequest.destination.repository.typeStringThe type of the repository of the destination branch.
Bitbucket.PullRequest.destination.repository.full_nameStringThe full name of the repository of the destination branch.
Bitbucket.PullRequest.destination.repository.linksStringLinks with information about the repository of the destination branch.
Bitbucket.PullRequest.destination.repository.nameStringThe name of the repository of the destination branch.
Bitbucket.PullRequest.destination.repository.uuidStringThe unique ID of the repository of the destination branch.
Bitbucket.PullRequest.source.branch.nameStringThe name of the source branch. The branch with the changes that will be merged.
Bitbucket.PullRequest.source.commit.typeStringThe type of the commit in the source branch.
Bitbucket.PullRequest.source.commit.hashStringThe hash of the commit in the source branch.
Bitbucket.PullRequest.source.commit.linksStringLinks with information about the commit in the source branch.
Bitbucket.PullRequest.source.repository.typeStringThe type of the repository of the source branch.
Bitbucket.PullRequest.source.repository.full_nameStringThe full name of the repository of the source branch.
Bitbucket.PullRequest.source.repository.linksStringLinks with information about the repository of the source branch.
Bitbucket.PullRequest.source.repository.nameStringThe name of the repository of the source branch.
Bitbucket.PullRequest.source.repository.uuidStringThe unique ID of the repository of the source branch.
Bitbucket.PullRequest.reviewers.display_nameStringThe display name of the reviewer.
Bitbucket.PullRequest.reviewers.linksStringLinks with information about the reviewer.
Bitbucket.PullRequest.reviewers.typeStringThe type of the reviewer.
Bitbucket.PullRequest.reviewers.uuidStringThe unique id of the reviewer.
Bitbucket.PullRequest.reviewers.account_idStringThe account id of the reviewer.
Bitbucket.PullRequest.reviewers.nicknameStringThe nickname of the reviewer.
Bitbucket.PullRequest.participants.typeStringThe type of the participant.
Bitbucket.PullRequest.participants.user.display_nameStringThe display name of the participant.
Bitbucket.PullRequest.participants.user.linksStringLinks with information about the user.
Bitbucket.PullRequest.participants.user.typeStringThe type of the participant.
Bitbucket.PullRequest.participants.user.uuidStringThe unique id of the participant.
Bitbucket.PullRequest.participants.user.account_idStringThe account id of the participant.
Bitbucket.PullRequest.participants.user.nicknameStringThe nickname of the participant.
Bitbucket.PullRequest.participants.roleStringThe role of the participant.
Bitbucket.PullRequest.participants.approvedStringThe approval status of the pull request.
Bitbucket.PullRequest.participants.stateStringThe state of the participant.
Bitbucket.PullRequest.participants.participated_onUnknownThe date of participation.
Bitbucket.PullRequest.linksStringLinks to information about the pull request.
Bitbucket.PullRequest.summary.typeStringThe type of the pull request.
Bitbucket.PullRequest.summary.rawStringThe description of the pull request.
Bitbucket.PullRequest.summary.markupStringThe text styling type, such as markdown.
Bitbucket.PullRequest.summary.htmlStringThe description of the pull request in HTML format.

Command example#

!bitbucket-pull-request-list

Context Example#

{
"Bitbucket": {
"PullRequest": [
{
"author": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.ne.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"close_source_branch": false,
"closed_by": null,
"comment_count": 12,
"created_on": "2022-09-12T09:00:00.000000+00:00",
"description": "",
"destination": {
"branch": {
"name": "master"
},
"commit": {
"hash": "111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/111111111111"
}
},
"type": "commit"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"participants": [
{
"approved": false,
"participated_on": "2022-09-15T12:00:00.000000+00:00",
"role": "PARTICIPANT",
"state": null,
"type": "participant",
"user": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net%initials.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
}
],
"reviewers": [
{
"display_name": "Some User",
"links": {
"self": {
"href": "https://api.bitbucket.org/2.0/users/"
},
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/"
}
},
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}",
"account_id": "111111111111111111111111",
"nickname": "Some User"
}
],
"id": 8,
"links": {
"activity": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/activity"
},
"approve": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/approve"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/comments"
},
"commits": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/commits"
},
"decline": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/decline"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diff/workspace/start_repo:111111111111%111111111111?from_pullrequest_id=8&topic=true"
},
"diffstat": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diffstat/workspace/start_repo:111111111111%111111111111?from_pullrequest_id=8&topic=true"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/pull-requests/8"
},
"merge": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/merge"
},
"request-changes": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/request-changes"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8"
},
"statuses": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/8/statuses"
}
},
"merge_commit": null,
"reason": "",
"source": {
"branch": {
"name": "test"
},
"commit": {
"hash": "111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/111111111111"
}
},
"type": "commit"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"state": "OPEN",
"summary": {
"html": "",
"markup": "markdown",
"raw": "",
"type": "rendered"
},
"task_count": 0,
"title": "pull_request",
"type": "pullrequest",
"updated_on": "2022-09-18T08:00:00.000000+00:00"
},
{
"author": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"close_source_branch": true,
"closed_by": null,
"comment_count": 10,
"created_on": "2022-09-08T12:00:00.000000+00:00",
"description": "updates description",
"destination": {
"branch": {
"name": "master"
},
"commit": {
"hash": "111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/111111111111"
}
},
"type": "commit"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"id": 6,
"links": {
"activity": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/6/activity"
},
"approve": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/6/approve"
},
"comments": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/6/comments"
},
"commits": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/6/commits"
},
"decline": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/6/decline"
},
"diff": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diff/workspace/start_repo:1111111111%111111111111?from_pullrequest_id=6&topic=true"
},
"diffstat": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/diffstat/workspace/start_repo:1111111111%111111111111?from_pullrequest_id=6&topic=true"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo/pull-requests/6"
},
"merge": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/6/merge"
},
"request-changes": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/6/request-changes"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/6"
},
"statuses": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/6/statuses"
}
},
"merge_commit": null,
"reason": "",
"source": {
"branch": {
"name": "branch"
},
"commit": {
"hash": "111111111111",
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/commits/111111111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/commit/111111111111"
}
},
"type": "commit"
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
"state": "OPEN",
"summary": {
"html": "<p>updates description</p>",
"markup": "markdown",
"raw": "updates description",
"type": "rendered"
},
"task_count": 0,
"title": "uuuupdate",
"type": "pullrequest",
"updated_on": "2022-09-15T12:00:00.000000+00:00"
}
]
}
}

Human Readable Output#

List of the pull requests#

IdTitleDescriptionSourceBranchDestinationBranchStateCreatedByCreatedAtUpdatedAt
8pull_requesttestmasterOPENSome User2022-09-12T09:51:55.458494+00:002022-09-18T08:57:20.815479+00:00
6uuuupdateupdates descriptionbranchmasterOPENSome User2022-09-08T12:23:04.303626+00:002022-09-15T12:44:45.785951+00:00

bitbucket-issue-comment-create#


Creates a comment on an issue in Bitbucket.

Base Command#

bitbucket-issue-comment-create

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
issue_idThe ID of the issue to comment on. To get the issue_id, use the !bitbucket-issue-list command.Required
contentThe content of the comment.Required
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.IssueComment.typeStringThe action type.
Bitbucket.IssueComment.idNumberThe ID of the comment on the issue.
Bitbucket.IssueComment.created_onStringThe creation date of the comment.
Bitbucket.IssueComment.updated_onUnknownWhen the comment was updated.
Bitbucket.IssueComment.content.typeStringThe type of the content.
Bitbucket.IssueComment.content.rawStringThe content of the comment.
Bitbucket.IssueComment.content.markupStringThe text styling type, such as markdown.
Bitbucket.IssueComment.content.htmlStringThe content of the comment in HTML format.
Bitbucket.IssueComment.user.display_nameStringThe display name of the user who created the comment.
Bitbucket.IssueComment.user.linksStringLinks with information about the user who created the comment.
Bitbucket.IssueComment.user.typeStringThe type of the user who created the comment.
Bitbucket.IssueComment.user.uuidStringThe unique ID of the user who created the comment.
Bitbucket.IssueComment.user.account_idStringThe account ID of the user who created the comment.
Bitbucket.IssueComment.user.nicknameStringThe nickname of the user who created the comment.
Bitbucket.IssueComment.issue.typeStringThe type of the issue.
Bitbucket.IssueComment.issue.idNumberThe ID of the issue.
Bitbucket.IssueComment.issue.repository.typeStringThe type of the repository connected to the relevant issue.
Bitbucket.IssueComment.issue.repository.full_nameStringThe full name of the repository connected to the relevant issue.
Bitbucket.IssueComment.issue.repository.linksStringLinks to information about the relevant repository.
Bitbucket.IssueComment.issue.repository.nameStringThe name of the relevant repository.
Bitbucket.IssueComment.issue.repository.uuidStringThe unique ID of the relevant repository.
Bitbucket.IssueComment.issue.linksStringLinks with information about the issue.
Bitbucket.IssueComment.issue.titleStringThe title of the issue.
Bitbucket.IssueComment.linksStringLinks to information about the comment.

Command example#

!bitbucket-issue-comment-create content="some comment" issue_id=1

Context Example#

{
"Bitbucket": {
"IssueComment": {
"content": {
"html": "<p>some comment</p>",
"markup": "markdown",
"raw": "some comment",
"type": "rendered"
},
"created_on": "2022-09-18T08:00:00.000000+00:00",
"id": 11111111,
"issue": {
"id": 1,
"links": {
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/1"
}
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"title": "new issue",
"type": "issue"
},
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/issues/1#comment-11111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/1/comments/11111111"
}
},
"type": "issue_comment",
"updated_on": null,
"user": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
}
}
}

Human Readable Output#

The comment was created successfully

bitbucket-issue-comment-delete#


Deletes a comment on an issue in Bitbucket.

Base Command#

bitbucket-issue-comment-delete

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
issue_idThe ID of the issue to comment on. To get the issue_id, use the !bitbucket-issue-list command.Required
comment_idThe ID of the comment to delete. To get the comment_id, use the !bitbucket-issue-comment-list command.Required

Context Output#

There is no context output for this command.

Human Readable Output#

The comment was deleted successfully

bitbucket-issue-comment-list#


Returns a list of comments on a specific issue. If a comment_id is given it will return information only about the specific comment.

Base Command#

bitbucket-issue-comment-list

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
issue_idThe ID of the issue to comment on. To get the issue_id, use the bitbucket-issue-list command.Required
comment_idThe ID of the comment to delete. To get the comment_id, use the !bitbucket-issue-comment-list command without any parameters.Optional
limitThe maximum number of items in the list. The default value is 50.Optional
pageThe specific result page to display.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.IssueComment.typeStringThe action type.
Bitbucket.IssueComment.idNumberThe ID of comment on the issue.
Bitbucket.IssueComment.created_onStringThe creation date of the comment.
Bitbucket.IssueComment.updated_onUnknownWhen the comment was updated.
Bitbucket.IssueComment.content.typeStringThe type of the content.
Bitbucket.IssueComment.content.rawStringThe content of the comment.
Bitbucket.IssueComment.content.markupStringThe text styling type, such as markdown.
Bitbucket.IssueComment.content.htmlStringThe content of the comment in HTML format.
Bitbucket.IssueComment.user.display_nameStringThe display name of the user who created the comment.
Bitbucket.IssueComment.user.linksStringLinks with information about the user who created the comment.
Bitbucket.IssueComment.user.typeStringThe type of the user who created the comment.
Bitbucket.IssueComment.user.uuidStringThe unique ID of the user who created the comment.
Bitbucket.IssueComment.user.account_idStringThe account ID of the user who created the comment.
Bitbucket.IssueComment.user.nicknameStringThe nickname of the user who created the comment.
Bitbucket.IssueComment.issue.typeStringThe type of the issue.
Bitbucket.IssueComment.issue.idNumberThe ID of the issue.
Bitbucket.IssueComment.issue.repository.typeStringThe type of the repository connected to the relevant issue.
Bitbucket.IssueComment.issue.repository.full_nameStringThe full name of the repository connected to the relevant issue.
Bitbucket.IssueComment.issue.repository.linksStringLinks to information about the relevant repository.
Bitbucket.IssueComment.issue.repository.nameStringThe name of the relevant repository.
Bitbucket.IssueComment.issue.repository.uuidStringThe unique ID of the relevant repository.
Bitbucket.IssueComment.issue.linksStringLinks with information about the issue.
Bitbucket.IssueComment.issue.titleStringThe title of the issue.
Bitbucket.IssueComment.linksStringLinks to information about the comment.

Command example#

!bitbucket-issue-comment-list issue_id=1

Context Example#

{
"Bitbucket": {
"IssueComment": [
{
"content": {
"html": "<p>new bug</p>",
"markup": "markdown",
"raw": "new bug",
"type": "rendered"
},
"created_on": "2022-09-06T14:00:00.000000+00:00",
"id": 11111111,
"issue": {
"id": 1,
"links": {
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/1"
}
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"title": "new issue",
"type": "issue"
},
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/issues/1#comment-11111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/1/comments/11111111"
}
},
"type": "issue_comment",
"updated_on": null,
"user": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
{
"content": {
"html": "<p>just a comment</p>",
"markup": "markdown",
"raw": "just a comment",
"type": "rendered"
},
"created_on": "2022-09-11T10:00:00.000000+00:00",
"id": 11111111,
"issue": {
"id": 1,
"links": {
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/1"
}
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"title": "new issue",
"type": "issue"
},
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/issues/1#comment-11111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/1/comments/11111111"
}
},
"type": "issue_comment",
"updated_on": null,
"user": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
}
]
}
}

Human Readable Output#

List of the comments on issue "1"#

IdContentCreatedByCreatedAtUpdatedAtIssueIdIssueTitle
11111111new bugSome User2022-09-06T14:23:03.776275+00:001new issue
11111111just a commentSome User2022-09-11T10:54:14.356238+00:001new issue

bitbucket-issue-comment-update#


Updates a specific comment on a given issue.

Base Command#

bitbucket-issue-comment-update

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
issue_idThe ID of the issue to comment on. To get the issue_id, use the !bitbucket-issue-list command.Required
comment_idThe ID of the comment to delete. To get the issue_id, use the !bitbucket-issue-comment-list command.Required
contentThe new content of the comment.Required
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.IssueComment.typeStringThe action type.
Bitbucket.IssueComment.idNumberThe ID of the comment on the issue.
Bitbucket.IssueComment.created_onStringThe creation date of the comment.
Bitbucket.IssueComment.updated_onUnknownWhen the comment was updated.
Bitbucket.IssueComment.content.typeStringThe type of the content.
Bitbucket.IssueComment.content.rawStringThe content of the comment.
Bitbucket.IssueComment.content.markupStringThe text styling type, such as markdown.
Bitbucket.IssueComment.content.htmlStringThe content of the comment in HTML format.
Bitbucket.IssueComment.user.display_nameStringThe display name of the user who created the comment.
Bitbucket.IssueComment.user.linksStringLinks with information about the user who created the comment.
Bitbucket.IssueComment.user.typeStringThe type of the user who created the comment.
Bitbucket.IssueComment.user.uuidStringThe unique ID of the user who created the comment.
Bitbucket.IssueComment.user.account_idStringThe account ID of the user who created the comment.
Bitbucket.IssueComment.user.nicknameStringThe nickname of the user who created the comment.
Bitbucket.IssueComment.issue.typeStringThe type of the issue.
Bitbucket.IssueComment.issue.idNumberThe ID of the issue.
Bitbucket.IssueComment.issue.repository.typeStringThe type of the repository connected to the relevant issue.
Bitbucket.IssueComment.issue.repository.full_nameStringThe full name of the repository connected to the relevant issue.
Bitbucket.IssueComment.issue.repository.linksStringLinks to information about the relevant repository.
Bitbucket.IssueComment.issue.repository.nameStringThe name of the relevant repository.
Bitbucket.IssueComment.issue.repository.uuidStringThe unique ID of the relevant repository.
Bitbucket.IssueComment.issue.linksStringLinks with information about the issue.
Bitbucket.IssueComment.issue.titleStringThe title of the issue.
Bitbucket.IssueComment.linksStringLinks to information about the comment.

Command example#

!bitbucket-issue-comment-update issue_id=1 comment_id=11111111 content="updating content info"

Context Example#

{
"Bitbucket": {
"IssueComment": {
"content": {
"html": "<p>updating content info</p>",
"markup": "markdown",
"raw": "updating content info",
"type": "rendered"
},
"created_on": "2022-09-14T15:00:00.000000+00:00",
"id": 11111111,
"issue": {
"id": 1,
"links": {
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/1"
}
},
"repository": {
"full_name": "workspace/start_repo",
"links": {
"avatar": {
"href": "https://bytebucket.org/ravatar/%1111111111-1111-1111-1111-111111111111%11?ts=default"
},
"html": {
"href": "https://bitbucket.org/workspace/start_repo"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo"
}
},
"name": "start_repo",
"type": "repository",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"title": "new issue",
"type": "issue"
},
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/issues/1#comment-11111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/issues/1/comments/11111111"
}
},
"type": "issue_comment",
"updated_on": "2022-09-18T08:00:00.000000+00:00",
"user": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
}
}
}

Human Readable Output#

The comment "11111111" on issue "1" was updated successfully

bitbucket-pull-request-comment-create#


Creates a new comment on a pull request.

Base Command#

bitbucket-pull-request-comment-create

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
pull_request_idThe ID of the pull request to comment on. To get the pull request ID, use the !bitbucket-pull-request-list command.Required
contentThe content of the comment.Required
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.PullRequestComment.idNumberThe ID of the comment in the pull request.
Bitbucket.PullRequestComment.created_onStringThe creation date of the pull request comment.
Bitbucket.PullRequestComment.updated_onStringThe update date of the pull request comment.
Bitbucket.PullRequestComment.content.typeStringThe type of the content, such as rendered.
Bitbucket.PullRequestComment.content.rawStringThe actual content of the comment.
Bitbucket.PullRequestComment.content.markupStringThe text styling type, such as markdown.
Bitbucket.PullRequestComment.content.htmlStringThe content of the comment in HTML format.
Bitbucket.PullRequestComment.user.display_nameStringThe display name of the user who created the comment.
Bitbucket.PullRequestComment.user.linksStringLinks to information about the user
Bitbucket.PullRequestComment.user.typeStringThe type of the user.
Bitbucket.PullRequestComment.user.uuidStringThe unique ID of the user.
Bitbucket.PullRequestComment.user.account_idStringThe account ID of the user.
Bitbucket.PullRequestComment.user.nicknameStringThe nickname of the user.
Bitbucket.PullRequestComment.deletedBooleanWhether the comment was deleted.
Bitbucket.PullRequestComment.typeStringThe type of the action.
Bitbucket.PullRequestComment.linksStringLinks to information about the pull request.
Bitbucket.PullRequestComment.pullrequest.typeStringThe type of the pull request.
Bitbucket.PullRequestComment.pullrequest.idNumberThe ID of the pull request.
Bitbucket.PullRequestComment.pullrequest.titleStringThe title of the pull request.
Bitbucket.PullRequestComment.pullrequest.linksStringLinks to information about the pull request.

Command example#

!bitbucket-pull-request-comment-create content="new comment on a pull request" pull_request_id=1

Context Example#

{
"Bitbucket": {
"PullRequestComment": [
{
"content": {
"html": "<p>new comment on a pull request</p>",
"markup": "markdown",
"raw": "new comment on a pull request",
"type": "rendered"
},
"created_on": "2022-09-18T08:00:00.000000+00:00",
"deleted": false,
"id": 11111111,
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/pull-requests/1/_/diff#comment-11111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/1/comments/11111111"
}
},
"pullrequest": {
"id": 1,
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/pull-requests/1"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/1"
}
},
"title": "change 2",
"type": "pullrequest"
},
"type": "pullrequest_comment",
"updated_on": "2022-09-18T08:00:00.000000+00:00",
"user": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
}
]
}
}

Human Readable Output#

The comment was created successfully

bitbucket-pull-request-comment-list#


Returns a list of comments of a specific pull request.

Base Command#

bitbucket-pull-request-comment-list

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
pull_request_idThe ID of the pull request. To get the pull_request_id, use the !bitbucket-pull-request-list command.Required
comment_idThe ID of the comment. To get the comment_id, use the !bitbucket-pull-request-comment-list command.Optional
limitThe maximum number of items in the list. The default value is 50.Optional
pageThe specific result page to display.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.PullRequestComment.idNumberThe ID of the comment in the pull request.
Bitbucket.PullRequestComment.created_onStringThe creation date of the pull request comment.
Bitbucket.PullRequestComment.updated_onStringThe update date of the pull request comment.
Bitbucket.PullRequestComment.content.typeStringThe type of the content, such as rendered.
Bitbucket.PullRequestComment.content.rawStringThe actual content of the comment.
Bitbucket.PullRequestComment.content.markupStringThe text styling type, such as markdown.
Bitbucket.PullRequestComment.content.htmlStringThe content of the comment in HTML format.
Bitbucket.PullRequestComment.user.display_nameStringThe display name of the user who created the comment.
Bitbucket.PullRequestComment.user.linksStringLinks to information about the user.
Bitbucket.PullRequestComment.user.typeStringThe type of the user.
Bitbucket.PullRequestComment.user.uuidStringThe unique ID of the user.
Bitbucket.PullRequestComment.user.account_idStringThe account ID of the user.
Bitbucket.PullRequestComment.user.nicknameStringThe nickname of the user.
Bitbucket.PullRequestComment.deletedBooleanWhether the comment was deleted.
Bitbucket.PullRequestComment.typeStringThe type of the action.
Bitbucket.PullRequestComment.linksStringLinks to information about the pull request.
Bitbucket.PullRequestComment.pullrequest.typeStringThe type of the pull request.
Bitbucket.PullRequestComment.pullrequest.idNumberThe ID of the pull request.
Bitbucket.PullRequestComment.pullrequest.titleStringThe title of the pull request.
Bitbucket.PullRequestComment.pullrequest.linksStringLinks to information about the pull request.

Command example#

!bitbucket-pull-request-comment-list pull_request_id=1

Context Example#

{
"Bitbucket": {
"PullRequestComment": [
{
"content": {
"html": "<p>new comment on a pull request</p>",
"markup": "markdown",
"raw": "new comment on a pull request",
"type": "rendered"
},
"created_on": "2022-09-18T08:00:00.000000+00:00",
"deleted": false,
"id": 11111111,
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/pull-requests/1/_/diff#comment-11111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/1/comments/11111111"
}
},
"pullrequest": {
"id": 1,
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/pull-requests/1"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/1"
}
},
"title": "change 2",
"type": "pullrequest"
},
"type": "pullrequest_comment",
"updated_on": "2022-09-18T08:00:00.000000+00:00",
"user": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
}
]
}
}

Human Readable Output#

List of the comments on pull request "1"#

IdContentCreatedByCreatedAtUpdatedAt
11111111new comment on a pull requestSome User2022-09-18T08:57:13.848266+00:002022-09-18T08:57:13.848309+00:00

bitbucket-pull-request-comment-update#


Updates a specific comment in a specific pull request.

Base Command#

bitbucket-pull-request-comment-update

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
pull_request_idThe ID of the pull request. To get the pull request_id use, the !bitbucket-pull-request-list command.Required
comment_idThe ID of the comment. To get the comment_id, use the !bitbucket-pull-request-comment-list command.Required
contentThe ID of the comment.Required
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.PullRequestComment.idNumberThe ID of the comment in the pull request.
Bitbucket.PullRequestComment.created_onStringThe creation date of the pull request comment.
Bitbucket.PullRequestComment.updated_onStringThe update date of the pull request comment.
Bitbucket.PullRequestComment.content.typeStringThe type of the content, such as rendered.
Bitbucket.PullRequestComment.content.rawStringThe actual content of the comment.
Bitbucket.PullRequestComment.content.markupStringThe text styling type, such as markdown.
Bitbucket.PullRequestComment.content.htmlStringThe content of the comment in HTML format.
Bitbucket.PullRequestComment.user.display_nameStringThe display name of the user who created the comment.
Bitbucket.PullRequestComment.user.linksStringLinks to information about the user.
Bitbucket.PullRequestComment.user.typeStringThe type of the user.
Bitbucket.PullRequestComment.user.uuidStringThe unique ID of the user.
Bitbucket.PullRequestComment.user.account_idStringThe account ID of the user.
Bitbucket.PullRequestComment.user.nicknameStringThe nickname of the user.
Bitbucket.PullRequestComment.deletedBooleanWhether the comment was deleted.
Bitbucket.PullRequestComment.typeStringThe type of the action.
Bitbucket.PullRequestComment.linksStringLinks to information about the pull request.
Bitbucket.PullRequestComment.pullrequest.typeStringThe type of the pull request.
Bitbucket.PullRequestComment.pullrequest.idNumberThe ID of the pull request.
Bitbucket.PullRequestComment.pullrequest.titleStringThe title of the pull request.
Bitbucket.PullRequestComment.pullrequest.linksStringLinks to information about the pull request.

Command example#

!bitbucket-pull-request-comment-update comment_id=111111111 content="hi you" pull_request_id=1

Context Example#

{
"Bitbucket": {
"PullRequestComment": [
{
"content": {
"html": "<p>new comment on a pull request</p>",
"markup": "markdown",
"raw": "new comment on a pull request",
"type": "rendered"
},
"created_on": "2022-09-18T08:00:00.000000+00:00",
"deleted": false,
"id": 11111111,
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/pull-requests/1/_/diff#comment-11111111"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/1/comments/11111111"
}
},
"pullrequest": {
"id": 1,
"links": {
"html": {
"href": "https://bitbucket.org/workspace/start_repo/pull-requests/1"
},
"self": {
"href": "https://api.bitbucket.org/2.0/repositories/workspace/start_repo/pullrequests/1"
}
},
"title": "change 2",
"type": "pullrequest"
},
"type": "pullrequest_comment",
"updated_on": "2022-09-18T08:00:00.000000+00:00",
"user": {
"account_id": "111111111111111111111111",
"display_name": "Some User",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/%7B11111111-1111-1111-1111-111111111111%7D/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "Some User",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
}
]
}
}

Human Readable Output#

The comment was updated successfully#

bitbucket-pull-request-comment-delete#


Deletes a specific comment in a specific pull request.

Base Command#

bitbucket-pull-request-comment-delete

Input#

Argument NameDescriptionRequired
repoThe repository name or slug.Optional
pull_request_idThe ID of the pull request. To get the pull_request_id, use the !bitbucket-pull-request-list command.Required
comment_idThe ID of the comment. To get the comment_id, use the !bitbucket-pull-request-comment-list command.Required

Context Output#

There is no context output for this command.

Command example#

!bitbucket-pull-request-comment-delete comment_id=331372169 pull_request_id=1

Human Readable Output#

The comment was deleted successfully.

bitbucket-workspace-member-list#


Returns a list of all the members in the workspace.

Base Command#

bitbucket-workspace-member-list

Input#

Argument NameDescriptionRequired
limitThe maximum number of items in the list. The default value is 50.Optional
pageThe specific result page to display.Optional
partial_responseReturn a partial response if true, else return the full API response. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
Bitbucket.WorkspaceMember.typeStringThe action type.
Bitbucket.WorkspaceMember.user.display_nameStringThe display name of the user.
Bitbucket.WorkspaceMember.user.linksStringLinks with information about the user.
Bitbucket.WorkspaceMember.user.typeStringThe type of the user.
Bitbucket.WorkspaceMember.user.uuidStringThe unique ID of the user.
Bitbucket.WorkspaceMember.user.account_idStringThe account ID of the user.
Bitbucket.WorkspaceMember.user.nicknameStringThe nickname of the user.
Bitbucket.WorkspaceMember.workspace.typeStringThe type of the workspace.
Bitbucket.WorkspaceMember.workspace.uuidStringThe unique ID of the workspace.
Bitbucket.WorkspaceMember.workspace.nameStringThe name of the workspace.
Bitbucket.WorkspaceMember.workspace.slugStringThe slug of the workspace.
Bitbucket.WorkspaceMember.workspace.linksStringLinks to information about the workspace.

Command example#

!bitbucket-workspace-member-list

Context Example#

{
"Bitbucket": {
"WorkspaceMember": [
{
"links": {
"self": {
"href": "https://api.bitbucket.org/2.0/workspaces/workspace/members/%111111111111-1111-1111-1111-111111111111%11"
}
},
"type": "workspace_membership",
"user": {
"account_id": "111111111111111111111111",
"display_name": "Display Name",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/%111111111111-1111-1111-1111-111111111111%11/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%7B11111111-1111-1111-1111-111111111111%7D"
}
},
"nickname": "nixkname",
"type": "user",
"uuid": "{11111111-1111-1111-1111-111111111111}"
},
"workspace": {
"links": {
"avatar": {
"href": "https://bitbucket.org/workspaces/workspace/avatar/?ts=1111111111"
},
"html": {
"href": "https://bitbucket.org/workspace/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/workspaces/workspace"
}
},
"name": "Some User",
"slug": "workspace",
"type": "workspace",
"uuid": "{11111111-1111-1111-1111-111111111111}"
}
},
{
"links": {
"self": {
"href": "https://api.bitbucket.org/2.0/workspaces/workspace/members/%11111111-1111-1111-1111-111111111111%11"
}
},
"type": "workspace_membership",
"user": {
"account_id": "222222222222222222222222",
"display_name": "Display Name",
"links": {
"avatar": {
"href": "https://secure.gravatar.com/avatar/?d=httpsavatar-management--avatars.us-west-2.prod.public.atl-paas.net.png"
},
"html": {
"href": "https://bitbucket.org/%22222222-2222-2222-2222-222222222222%11/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/users/%22222222-2222-2222-2222-222222222222%22"
}
},
"nickname": "nickname",
"type": "user",
"uuid": "{22222222-2222-2222-2222-222222222222}"
},
"workspace": {
"links": {
"avatar": {
"href": "https://bitbucket.org/workspaces/workspace/avatar/?ts=22222222"
},
"html": {
"href": "https://bitbucket.org/workspace/"
},
"self": {
"href": "https://api.bitbucket.org/2.0/workspaces/workspace"
}
},
"name": "Another User",
"slug": "workspace",
"type": "workspace",
"uuid": "{222222222-2222-2222-2222-222222222222}"
}
}
]
}
}

Human Readable Output#

The list of all the workspace members#

NameAccountId
Some User111111111111111111111111
Another User222222222222222222222222