Bitbucket is Atlassian's Git hosting service for code, pull requests, and CI/CD with Bitbucket Pipelines.
With the Bitbucket block, you can:
- Browse workspaces and repositories: List workspaces and repositories, and read repository details
- Read source code: List branches, commits, and directory contents, and read files and file metadata
- Manage branches: Create and delete branches
- Work on pull requests: List, read, create, approve, merge, and decline pull requests, read their diffs, and list or add comments
- Run pipelines: List pipelines and their steps, trigger or stop a pipeline, and read step logs
Connect your Bitbucket account with OAuth. The Bitbucket triggers can also start a workflow on pushes, repository changes, build status updates, and pull request events, with the webhook managed for you.
In Sim, the Bitbucket block lets your agents take part in your development process: review a pull request when it opens, summarize a failed pipeline from its step logs, or cut a release branch and open the pull request for it.
Connect Bitbucket Cloud to inspect repositories and source, collaborate on pull requests, diagnose or control pipelines, and start workflows from repository and pull request events. OAuth is used for actions and automatic webhook management.
List Bitbucket Cloud workspaces available to the authenticated account
| Parameter | Type | Required | Description |
|---|
sort | string | No | Workspace sort field; Bitbucket currently supports slug |
administrator | boolean | No | Filter by whether the caller is a workspace administrator |
nextUrl | string | No | Opaque next-page URL returned by a previous Bitbucket call |
pageLen | number | No | Results per page (1-100) |
| Parameter | Type | Description |
|---|
page | object | Pagination information |
↳ size | number | Total result count reported by Bitbucket |
↳ page | number | Current page number |
↳ pageLen | number | Number of results requested per page |
↳ nextUrl | string | Validated URL for the next page |
↳ previousUrl | string | Validated URL for the previous page |
items | array | Workspace access records |
↳ type | string | Bitbucket workspace-access object type |
↳ slug | string | Workspace slug |
↳ uuid | string | Workspace UUID |
↳ administrator | boolean | Whether the caller administers the workspace |
↳ selfUrl | string | Workspace API URL |
↳ avatarUrl | string | Workspace avatar URL |
List repositories in a Bitbucket Cloud workspace
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
role | string | No | Caller role filter: admin, contributor, member, or owner |
q | string | No | Bitbucket filtering expression |
sort | string | No | Bitbucket sort expression |
nextUrl | string | No | Opaque next-page URL returned by a previous Bitbucket call |
pageLen | number | No | Results per page (1-100) |
| Parameter | Type | Description |
|---|
page | object | Pagination information |
↳ size | number | Total result count reported by Bitbucket |
↳ page | number | Current page number |
↳ pageLen | number | Number of results requested per page |
↳ nextUrl | string | Validated URL for the next page |
↳ previousUrl | string | Validated URL for the previous page |
items | array | Repositories |
↳ type | string | Bitbucket repository object type |
↳ uuid | string | Repository UUID |
↳ slug | string | Repository slug |
↳ name | string | Repository name |
↳ fullName | string | Workspace and repository full name |
↳ description | string | Repository description |
↳ isPrivate | boolean | Whether the repository is private |
↳ scm | string | Source control system |
↳ language | string | Primary repository language |
↳ size | number | Repository size in bytes |
↳ createdOn | string | Repository creation timestamp |
↳ updatedOn | string | Repository update timestamp |
↳ mainBranch | string | Main branch name |
↳ owner | object | Repository owner |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ project | object | Containing Bitbucket project |
↳ uuid | string | Project UUID |
↳ key | string | Project key |
↳ name | string | Project name |
↳ selfUrl | string | Repository API URL |
↳ htmlUrl | string | Repository web URL |
Get a Bitbucket Cloud repository
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
| Parameter | Type | Description |
|---|
repository | object | Repository details |
↳ type | string | Bitbucket repository object type |
↳ uuid | string | Repository UUID |
↳ slug | string | Repository slug |
↳ name | string | Repository name |
↳ fullName | string | Workspace and repository full name |
↳ description | string | Repository description |
↳ isPrivate | boolean | Whether the repository is private |
↳ scm | string | Source control system |
↳ language | string | Primary repository language |
↳ size | number | Repository size in bytes |
↳ createdOn | string | Repository creation timestamp |
↳ updatedOn | string | Repository update timestamp |
↳ mainBranch | string | Main branch name |
↳ owner | object | Repository owner |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ project | object | Containing Bitbucket project |
↳ uuid | string | Project UUID |
↳ key | string | Project key |
↳ name | string | Project name |
↳ selfUrl | string | Repository API URL |
↳ htmlUrl | string | Repository web URL |
List branches in a Bitbucket Cloud repository
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
q | string | No | Bitbucket branch filtering expression |
sort | string | No | Bitbucket branch sort expression |
nextUrl | string | No | Opaque next-page URL returned by a previous Bitbucket call |
pageLen | number | No | Results per page (1-100) |
| Parameter | Type | Description |
|---|
page | object | Pagination information |
↳ size | number | Total result count reported by Bitbucket |
↳ page | number | Current page number |
↳ pageLen | number | Number of results requested per page |
↳ nextUrl | string | Validated URL for the next page |
↳ previousUrl | string | Validated URL for the previous page |
items | array | Branches |
↳ type | string | Bitbucket branch object type |
↳ name | string | Branch name |
↳ target | object | Commit targeted by the branch |
↳ type | string | Bitbucket commit object type |
↳ hash | string | Commit hash |
↳ date | string | Commit timestamp |
↳ message | string | Full commit message |
↳ summary | string | Raw commit summary |
↳ authorRaw | string | Raw author value stored by Git |
↳ author | object | Matched Bitbucket account, when available |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ committerRaw | string | Raw committer value stored by Git |
↳ committer | object | Matched Bitbucket committer account, when available |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ parents | array | Parent commits |
↳ hash | string | Parent commit hash |
↳ selfUrl | string | Commit API URL |
↳ htmlUrl | string | Commit web URL |
↳ mergeStrategies | array | Merge strategies available for the branch |
↳ defaultMergeStrategy | string | Default merge strategy |
↳ selfUrl | string | Branch API URL |
↳ htmlUrl | string | Branch web URL |
Create a branch at a commit hash or existing ref
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
name | string | Yes | New branch name without refs/heads prefix |
target | string | Yes | Full commit hash or existing ref to target |
| Parameter | Type | Description |
|---|
branch | object | Created branch |
↳ type | string | Bitbucket branch object type |
↳ name | string | Branch name |
↳ target | object | Commit targeted by the branch |
↳ type | string | Bitbucket commit object type |
↳ hash | string | Commit hash |
↳ date | string | Commit timestamp |
↳ message | string | Full commit message |
↳ summary | string | Raw commit summary |
↳ authorRaw | string | Raw author value stored by Git |
↳ author | object | Matched Bitbucket account, when available |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ committerRaw | string | Raw committer value stored by Git |
↳ committer | object | Matched Bitbucket committer account, when available |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ parents | array | Parent commits |
↳ hash | string | Parent commit hash |
↳ selfUrl | string | Commit API URL |
↳ htmlUrl | string | Commit web URL |
↳ mergeStrategies | array | Merge strategies available for the branch |
↳ defaultMergeStrategy | string | Default merge strategy |
↳ selfUrl | string | Branch API URL |
↳ htmlUrl | string | Branch web URL |
Delete a branch from a Bitbucket Cloud repository
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
name | string | Yes | Branch name to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the branch was deleted |
List repository commits in reverse chronological order
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
nextUrl | string | No | Opaque next-page URL returned by a previous Bitbucket call |
pageLen | number | No | Results per page (1-100) |
| Parameter | Type | Description |
|---|
page | object | Pagination information |
↳ size | number | Total result count reported by Bitbucket |
↳ page | number | Current page number |
↳ pageLen | number | Number of results requested per page |
↳ nextUrl | string | Validated URL for the next page |
↳ previousUrl | string | Validated URL for the previous page |
items | array | Commits |
↳ type | string | Bitbucket commit object type |
↳ hash | string | Commit hash |
↳ date | string | Commit timestamp |
↳ message | string | Full commit message |
↳ summary | string | Raw commit summary |
↳ authorRaw | string | Raw author value stored by Git |
↳ author | object | Matched Bitbucket account, when available |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ committerRaw | string | Raw committer value stored by Git |
↳ committer | object | Matched Bitbucket committer account, when available |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ parents | array | Parent commits |
↳ hash | string | Parent commit hash |
↳ selfUrl | string | Commit API URL |
↳ htmlUrl | string | Commit web URL |
Get a repository commit by its full SHA-1
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
commit | string | Yes | Full 40-character commit SHA-1 |
| Parameter | Type | Description |
|---|
commit | object | Commit details |
↳ type | string | Bitbucket commit object type |
↳ hash | string | Commit hash |
↳ date | string | Commit timestamp |
↳ message | string | Full commit message |
↳ summary | string | Raw commit summary |
↳ authorRaw | string | Raw author value stored by Git |
↳ author | object | Matched Bitbucket account, when available |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ committerRaw | string | Raw committer value stored by Git |
↳ committer | object | Matched Bitbucket committer account, when available |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ parents | array | Parent commits |
↳ hash | string | Parent commit hash |
↳ selfUrl | string | Commit API URL |
↳ htmlUrl | string | Commit web URL |
List one shallow repository directory at a full commit SHA-1
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
commit | string | Yes | Full 40-character commit SHA-1 |
path | string | No | Repository-relative directory path; omit for the root |
q | string | No | Bitbucket tree-entry filtering expression |
sort | string | No | Bitbucket tree-entry sort expression |
nextUrl | string | No | Opaque next-page URL returned by a previous Bitbucket call |
pageLen | number | No | Results per page (1-100) |
| Parameter | Type | Description |
|---|
page | object | Pagination information |
↳ size | number | Total result count reported by Bitbucket |
↳ page | number | Current page number |
↳ pageLen | number | Number of results requested per page |
↳ nextUrl | string | Validated URL for the next page |
↳ previousUrl | string | Validated URL for the previous page |
items | array | Directory entries |
↳ type | string | Entry type, such as commit_file or commit_directory |
↳ path | string | Repository-relative path |
↳ commitHash | string | Resolved commit hash |
↳ size | number | File size in bytes when the entry is a file |
↳ attributes | array | File attributes when the entry is a file |
↳ isBinary | boolean | Whether file attributes include the binary marker |
↳ selfUrl | string | Source API URL |
↳ metadataUrl | string | Source metadata API URL |
Inspect file size and attributes at a full repository commit SHA-1
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
commit | string | Yes | Full 40-character commit SHA-1 |
path | string | Yes | Repository-relative file path |
| Parameter | Type | Description |
|---|
file | object | File metadata |
↳ type | string | Entry type (commit_file) |
↳ path | string | Repository-relative path |
↳ commitHash | string | Resolved commit hash |
↳ escapedPath | string | Escaped display path |
↳ size | number | File size in bytes |
↳ attributes | array | File attributes reported by Bitbucket |
↳ isBinary | boolean | Whether the documented attributes include the binary marker |
Read bounded UTF-8 text from a file at a full repository commit SHA-1
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
commit | string | Yes | Full 40-character commit SHA-1 |
path | string | Yes | Repository-relative file path |
maxCharacters | number | No | Maximum text characters to return (1-500000) |
| Parameter | Type | Description |
|---|
content | string | Bounded UTF-8 file text; null for binary content |
binary | boolean | Whether documented metadata identifies binary content; null when unknown |
truncated | boolean | Whether later content was omitted; null when binary size is unknown |
returnedBytes | number | Provider bytes read for the returned file |
fullBytes | number | Full file byte size when reported |
contentType | string | Response MIME type |
List pull requests in a Bitbucket Cloud repository
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
state | string | No | State filter: OPEN, MERGED, DECLINED, or SUPERSEDED |
q | string | No | Bitbucket pull request filtering expression |
sort | string | No | Bitbucket pull request sort expression |
nextUrl | string | No | Opaque next-page URL returned by a previous Bitbucket call |
pageLen | number | No | Results per page (1-100) |
| Parameter | Type | Description |
|---|
page | object | Pagination information |
↳ size | number | Total result count reported by Bitbucket |
↳ page | number | Current page number |
↳ pageLen | number | Number of results requested per page |
↳ nextUrl | string | Validated URL for the next page |
↳ previousUrl | string | Validated URL for the previous page |
items | array | Pull requests |
↳ type | string | Bitbucket pull request object type |
↳ id | number | Repository-scoped pull request ID |
↳ title | string | Pull request title |
↳ description | string | Pull request description |
↳ state | string | Pull request state |
↳ draft | boolean | Whether the pull request is a draft |
↳ queued | boolean | Whether the pull request is queued |
↳ author | object | Pull request author |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ closedBy | object | Account that closed the pull request |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ source | object | Source endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ destination | object | Destination endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ mergeCommitHash | string | Merge commit hash |
↳ commentCount | number | Comment count |
↳ taskCount | number | Open task count |
↳ closeSourceBranch | boolean | Whether merging closes the source branch |
↳ reason | string | Reason the pull request was declined |
↳ createdOn | string | Creation timestamp |
↳ updatedOn | string | Update timestamp |
↳ reviewers | array | Explicit reviewers |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ participants | array | Pull request participants |
↳ type | string | Bitbucket participant object type |
↳ user | object | Participating account |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ role | string | Participant role |
↳ approved | boolean | Whether the participant approved |
↳ state | string | Review state |
↳ participatedOn | string | Timestamp of the participant action |
↳ selfUrl | string | Pull request API URL |
↳ htmlUrl | string | Pull request web URL |
Get a pull request by repository-scoped ID
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
prId | number | Yes | Repository-scoped pull request ID |
| Parameter | Type | Description |
|---|
pullRequest | object | Pull request details |
↳ type | string | Bitbucket pull request object type |
↳ id | number | Repository-scoped pull request ID |
↳ title | string | Pull request title |
↳ description | string | Pull request description |
↳ state | string | Pull request state |
↳ draft | boolean | Whether the pull request is a draft |
↳ queued | boolean | Whether the pull request is queued |
↳ author | object | Pull request author |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ closedBy | object | Account that closed the pull request |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ source | object | Source endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ destination | object | Destination endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ mergeCommitHash | string | Merge commit hash |
↳ commentCount | number | Comment count |
↳ taskCount | number | Open task count |
↳ closeSourceBranch | boolean | Whether merging closes the source branch |
↳ reason | string | Reason the pull request was declined |
↳ createdOn | string | Creation timestamp |
↳ updatedOn | string | Update timestamp |
↳ reviewers | array | Explicit reviewers |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ participants | array | Pull request participants |
↳ type | string | Bitbucket participant object type |
↳ user | object | Participating account |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ role | string | Participant role |
↳ approved | boolean | Whether the participant approved |
↳ state | string | Review state |
↳ participatedOn | string | Timestamp of the participant action |
↳ selfUrl | string | Pull request API URL |
↳ htmlUrl | string | Pull request web URL |
Create a pull request between repository branches
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
title | string | Yes | Pull request title |
sourceBranch | string | Yes | Source branch name |
destinationBranch | string | Yes | Destination branch name |
description | string | No | Pull request description |
closeSourceBranch | boolean | No | Close the source branch after merge |
draft | boolean | No | Create the pull request as a draft |
reviewerUuids | array | No | Bitbucket account UUIDs to add as reviewers |
| Parameter | Type | Description |
|---|
pullRequest | object | Created pull request |
↳ type | string | Bitbucket pull request object type |
↳ id | number | Repository-scoped pull request ID |
↳ title | string | Pull request title |
↳ description | string | Pull request description |
↳ state | string | Pull request state |
↳ draft | boolean | Whether the pull request is a draft |
↳ queued | boolean | Whether the pull request is queued |
↳ author | object | Pull request author |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ closedBy | object | Account that closed the pull request |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ source | object | Source endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ destination | object | Destination endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ mergeCommitHash | string | Merge commit hash |
↳ commentCount | number | Comment count |
↳ taskCount | number | Open task count |
↳ closeSourceBranch | boolean | Whether merging closes the source branch |
↳ reason | string | Reason the pull request was declined |
↳ createdOn | string | Creation timestamp |
↳ updatedOn | string | Update timestamp |
↳ reviewers | array | Explicit reviewers |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ participants | array | Pull request participants |
↳ type | string | Bitbucket participant object type |
↳ user | object | Participating account |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ role | string | Participant role |
↳ approved | boolean | Whether the participant approved |
↳ state | string | Review state |
↳ participatedOn | string | Timestamp of the participant action |
↳ selfUrl | string | Pull request API URL |
↳ htmlUrl | string | Pull request web URL |
Start an asynchronous pull request merge and return a task to poll when needed
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
prId | number | Yes | Repository-scoped pull request ID |
mergeStrategy | string | No | Merge strategy: merge_commit, squash, fast_forward, squash_fast_forward, rebase_fast_forward, or rebase_merge |
message | string | No | Merge commit message (maximum 128 KiB encoded as UTF-8) |
closeSourceBranch | boolean | No | Delete the source branch after merging |
| Parameter | Type | Description |
|---|
status | string | Whether the merge completed or remains pending |
taskId | string | Async merge task ID |
taskUrl | string | Validated task polling URL |
pullRequest | object | Merged pull request when completed synchronously |
↳ type | string | Bitbucket pull request object type |
↳ id | number | Repository-scoped pull request ID |
↳ title | string | Pull request title |
↳ description | string | Pull request description |
↳ state | string | Pull request state |
↳ draft | boolean | Whether the pull request is a draft |
↳ queued | boolean | Whether the pull request is queued |
↳ author | object | Pull request author |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ closedBy | object | Account that closed the pull request |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ source | object | Source endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ destination | object | Destination endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ mergeCommitHash | string | Merge commit hash |
↳ commentCount | number | Comment count |
↳ taskCount | number | Open task count |
↳ closeSourceBranch | boolean | Whether merging closes the source branch |
↳ reason | string | Reason the pull request was declined |
↳ createdOn | string | Creation timestamp |
↳ updatedOn | string | Update timestamp |
↳ reviewers | array | Explicit reviewers |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ participants | array | Pull request participants |
↳ type | string | Bitbucket participant object type |
↳ user | object | Participating account |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ role | string | Participant role |
↳ approved | boolean | Whether the participant approved |
↳ state | string | Review state |
↳ participatedOn | string | Timestamp of the participant action |
↳ selfUrl | string | Pull request API URL |
↳ htmlUrl | string | Pull request web URL |
Poll the status of an asynchronous pull request merge task
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
prId | number | Yes | Repository-scoped pull request ID |
taskId | string | Yes | Merge task ID returned by Bitbucket Merge Pull Request |
| Parameter | Type | Description |
|---|
taskStatus | string | PENDING or SUCCESS |
selfUrl | string | Merge task API URL |
mergeResult | object | Merged pull request when the task succeeds |
↳ type | string | Bitbucket pull request object type |
↳ id | number | Repository-scoped pull request ID |
↳ title | string | Pull request title |
↳ description | string | Pull request description |
↳ state | string | Pull request state |
↳ draft | boolean | Whether the pull request is a draft |
↳ queued | boolean | Whether the pull request is queued |
↳ author | object | Pull request author |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ closedBy | object | Account that closed the pull request |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ source | object | Source endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ destination | object | Destination endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ mergeCommitHash | string | Merge commit hash |
↳ commentCount | number | Comment count |
↳ taskCount | number | Open task count |
↳ closeSourceBranch | boolean | Whether merging closes the source branch |
↳ reason | string | Reason the pull request was declined |
↳ createdOn | string | Creation timestamp |
↳ updatedOn | string | Update timestamp |
↳ reviewers | array | Explicit reviewers |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ participants | array | Pull request participants |
↳ type | string | Bitbucket participant object type |
↳ user | object | Participating account |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ role | string | Participant role |
↳ approved | boolean | Whether the participant approved |
↳ state | string | Review state |
↳ participatedOn | string | Timestamp of the participant action |
↳ selfUrl | string | Pull request API URL |
↳ htmlUrl | string | Pull request web URL |
Decline an open pull request
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
prId | number | Yes | Repository-scoped pull request ID |
| Parameter | Type | Description |
|---|
pullRequest | object | Declined pull request |
↳ type | string | Bitbucket pull request object type |
↳ id | number | Repository-scoped pull request ID |
↳ title | string | Pull request title |
↳ description | string | Pull request description |
↳ state | string | Pull request state |
↳ draft | boolean | Whether the pull request is a draft |
↳ queued | boolean | Whether the pull request is queued |
↳ author | object | Pull request author |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ closedBy | object | Account that closed the pull request |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ source | object | Source endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ destination | object | Destination endpoint |
↳ branchName | string | Branch name |
↳ commitHash | string | Commit hash |
↳ repositoryUuid | string | Repository UUID |
↳ repositoryFullName | string | Repository full name |
↳ mergeCommitHash | string | Merge commit hash |
↳ commentCount | number | Comment count |
↳ taskCount | number | Open task count |
↳ closeSourceBranch | boolean | Whether merging closes the source branch |
↳ reason | string | Reason the pull request was declined |
↳ createdOn | string | Creation timestamp |
↳ updatedOn | string | Update timestamp |
↳ reviewers | array | Explicit reviewers |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ participants | array | Pull request participants |
↳ type | string | Bitbucket participant object type |
↳ user | object | Participating account |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ role | string | Participant role |
↳ approved | boolean | Whether the participant approved |
↳ state | string | Review state |
↳ participatedOn | string | Timestamp of the participant action |
↳ selfUrl | string | Pull request API URL |
↳ htmlUrl | string | Pull request web URL |
Approve a pull request as the authenticated account
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
prId | number | Yes | Repository-scoped pull request ID |
| Parameter | Type | Description |
|---|
participant | object | Approval participant record |
↳ type | string | Bitbucket participant object type |
↳ user | object | Participating account |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ role | string | Participant role |
↳ approved | boolean | Whether the participant approved |
↳ state | string | Review state |
↳ participatedOn | string | Timestamp of the participant action |
Request changes on a pull request as the authenticated account
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
prId | number | Yes | Repository-scoped pull request ID |
| Parameter | Type | Description |
|---|
participant | object | Change-request participant record |
↳ type | string | Bitbucket participant object type |
↳ user | object | Participating account |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ role | string | Participant role |
↳ approved | boolean | Whether the participant approved |
↳ state | string | Review state |
↳ participatedOn | string | Timestamp of the participant action |
Read a bounded UTF-8 unified diff for one pull request file
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
prId | number | Yes | Repository-scoped pull request ID |
path | string | Yes | Repository-relative file path to include in the diff |
maxCharacters | number | No | Maximum diff characters to return (1-500000) |
| Parameter | Type | Description |
|---|
diff | string | Bounded unified diff text decoded as UTF-8 |
decodingLossy | boolean | Whether invalid UTF-8 source bytes were replaced while decoding |
truncated | boolean | Whether later diff text was omitted |
returnedBytes | number | Provider bytes read for the returned diff |
fullBytes | number | Full diff byte size when reported |
List per-file change statistics for a pull request
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
prId | number | Yes | Repository-scoped pull request ID |
nextUrl | string | No | Opaque next-page URL returned by a previous Bitbucket call |
pageLen | number | No | Results per page (1-100) |
| Parameter | Type | Description |
|---|
page | object | Pagination information |
↳ size | number | Total result count reported by Bitbucket |
↳ page | number | Current page number |
↳ pageLen | number | Number of results requested per page |
↳ nextUrl | string | Validated URL for the next page |
↳ previousUrl | string | Validated URL for the previous page |
items | array | Per-file diff statistics |
↳ type | string | Diffstat object type |
↳ status | string | File change status |
↳ linesAdded | number | Lines added |
↳ linesRemoved | number | Lines removed |
↳ oldPath | string | Old file path |
↳ newPath | string | New file path |
↳ oldCommitHash | string | Old file commit hash |
↳ newCommitHash | string | New file commit hash |
List global, inline, and reply comments on a pull request
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
prId | number | Yes | Repository-scoped pull request ID |
q | string | No | Bitbucket comment filtering expression |
sort | string | No | Bitbucket comment sort expression |
nextUrl | string | No | Opaque next-page URL returned by a previous Bitbucket call |
pageLen | number | No | Results per page (1-100) |
| Parameter | Type | Description |
|---|
page | object | Pagination information |
↳ size | number | Total result count reported by Bitbucket |
↳ page | number | Current page number |
↳ pageLen | number | Number of results requested per page |
↳ nextUrl | string | Validated URL for the next page |
↳ previousUrl | string | Validated URL for the previous page |
items | array | Pull request comments |
↳ type | string | Bitbucket comment object type |
↳ id | number | Comment ID |
↳ createdOn | string | Creation timestamp |
↳ updatedOn | string | Update timestamp |
↳ content | string | Raw comment content |
↳ user | object | Comment author |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ deleted | boolean | Whether the comment was deleted |
↳ parentId | number | Parent comment ID |
↳ inline | object | Inline comment anchor |
↳ path | string | Anchored file path |
↳ from | number | Ending line in the old file |
↳ to | number | Ending line in the new file |
↳ startFrom | number | Starting line in the old file |
↳ startTo | number | Starting line in the new file |
↳ pending | boolean | Whether the comment is pending |
↳ resolution | object | Comment resolution details |
↳ resolver | object | Account that resolved the comment |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ resolvedOn | string | Resolution timestamp |
↳ selfUrl | string | Comment API URL |
↳ htmlUrl | string | Comment web URL |
Create a global comment or reply on a pull request
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
prId | number | Yes | Repository-scoped pull request ID |
content | string | Yes | Raw comment content |
parentId | number | No | Parent comment ID when creating a reply |
| Parameter | Type | Description |
|---|
comment | object | Created comment |
↳ type | string | Bitbucket comment object type |
↳ id | number | Comment ID |
↳ createdOn | string | Creation timestamp |
↳ updatedOn | string | Update timestamp |
↳ content | string | Raw comment content |
↳ user | object | Comment author |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ deleted | boolean | Whether the comment was deleted |
↳ parentId | number | Parent comment ID |
↳ inline | object | Inline comment anchor |
↳ path | string | Anchored file path |
↳ from | number | Ending line in the old file |
↳ to | number | Ending line in the new file |
↳ startFrom | number | Starting line in the old file |
↳ startTo | number | Starting line in the new file |
↳ pending | boolean | Whether the comment is pending |
↳ resolution | object | Comment resolution details |
↳ resolver | object | Account that resolved the comment |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ resolvedOn | string | Resolution timestamp |
↳ selfUrl | string | Comment API URL |
↳ htmlUrl | string | Comment web URL |
List commit statuses associated with a pull request
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
prId | number | Yes | Repository-scoped pull request ID |
q | string | No | Bitbucket commit status filtering expression |
sort | string | No | Bitbucket commit status sort expression |
nextUrl | string | No | Opaque next-page URL returned by a previous Bitbucket call |
pageLen | number | No | Results per page (1-100) |
| Parameter | Type | Description |
|---|
page | object | Pagination information |
↳ size | number | Total result count reported by Bitbucket |
↳ page | number | Current page number |
↳ pageLen | number | Number of results requested per page |
↳ nextUrl | string | Validated URL for the next page |
↳ previousUrl | string | Validated URL for the previous page |
items | array | Pull request commit statuses |
↳ type | string | Bitbucket commit-status object type |
↳ key | string | Vendor-unique status key |
↳ refName | string | Reference name at status creation time |
↳ url | string | External build URL |
↳ state | string | Commit status state |
↳ name | string | Build name |
↳ description | string | Build description |
↳ createdOn | string | Creation timestamp |
↳ updatedOn | string | Update timestamp |
↳ selfUrl | string | Status API URL |
↳ commitUrl | string | Commit API URL |
List pipelines for a Bitbucket Cloud repository
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
refType | string | No | Reference type filter: BRANCH, TAG, or ANNOTATED_TAG |
refName | string | No | Reference name filter |
commitHash | string | No | Full 40-character target commit SHA-1 filter |
selectorType | string | No | Selector type filter: BRANCH, TAG, CUSTOM, PULLREQUESTS, or DEFAULT |
selectorPattern | string | No | Pipeline selector pattern filter |
triggerType | string | No | Trigger filter: PUSH, MANUAL, SCHEDULED, or PARENT_STEP |
status | string | No | Pipeline status filter |
sort | string | No | Bitbucket pipeline sort expression |
nextUrl | string | No | Opaque next-page URL returned by a previous Bitbucket call |
pageLen | number | No | Results per page (1-100) |
| Parameter | Type | Description |
|---|
page | object | Pagination information |
↳ size | number | Total result count reported by Bitbucket |
↳ page | number | Current page number |
↳ pageLen | number | Number of results requested per page |
↳ nextUrl | string | Validated URL for the next page |
↳ previousUrl | string | Validated URL for the previous page |
items | array | Pipelines |
↳ type | string | Bitbucket pipeline object type |
↳ uuid | string | Pipeline UUID |
↳ buildNumber | number | Pipeline build number |
↳ creator | object | Pipeline creator |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ repositoryFullName | string | Repository full name |
↳ target | object | Pipeline target |
↳ type | string | Target object type |
↳ refType | string | Reference type |
↳ refName | string | Reference name |
↳ commitHash | string | Target commit hash |
↳ selectorType | string | Pipeline selector type |
↳ selectorPattern | string | Pipeline selector pattern |
↳ triggerType | string | Pipeline trigger object type |
↳ state | object | Pipeline state |
↳ name | string | State name |
↳ stage | string | In-progress stage name |
↳ result | string | Completed result name |
↳ errorKey | string | Completed-error key |
↳ errorMessage | string | Completed-error message |
↳ createdOn | string | Creation timestamp |
↳ completedOn | string | Completion timestamp |
↳ buildSecondsUsed | number | Build seconds used |
↳ selfUrl | string | Pipeline API URL |
↳ stepsUrl | string | Pipeline steps API URL |
Get a pipeline by UUID
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
pipelineUuid | string | Yes | Pipeline UUID |
| Parameter | Type | Description |
|---|
pipeline | object | Pipeline details |
↳ type | string | Bitbucket pipeline object type |
↳ uuid | string | Pipeline UUID |
↳ buildNumber | number | Pipeline build number |
↳ creator | object | Pipeline creator |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ repositoryFullName | string | Repository full name |
↳ target | object | Pipeline target |
↳ type | string | Target object type |
↳ refType | string | Reference type |
↳ refName | string | Reference name |
↳ commitHash | string | Target commit hash |
↳ selectorType | string | Pipeline selector type |
↳ selectorPattern | string | Pipeline selector pattern |
↳ triggerType | string | Pipeline trigger object type |
↳ state | object | Pipeline state |
↳ name | string | State name |
↳ stage | string | In-progress stage name |
↳ result | string | Completed result name |
↳ errorKey | string | Completed-error key |
↳ errorMessage | string | Completed-error message |
↳ createdOn | string | Creation timestamp |
↳ completedOn | string | Completion timestamp |
↳ buildSecondsUsed | number | Build seconds used |
↳ selfUrl | string | Pipeline API URL |
↳ stepsUrl | string | Pipeline steps API URL |
Run the repository pipeline selected by a branch or ref target
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
refType | string | Yes | Reference type: branch, tag, named_branch, or bookmark |
refName | string | Yes | Reference name |
commitHash | string | No | Full 40-character commit SHA-1 to run in the reference context |
| Parameter | Type | Description |
|---|
pipeline | object | Triggered pipeline |
↳ type | string | Bitbucket pipeline object type |
↳ uuid | string | Pipeline UUID |
↳ buildNumber | number | Pipeline build number |
↳ creator | object | Pipeline creator |
↳ type | string | Bitbucket account object type |
↳ uuid | string | Bitbucket account UUID |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Account display name |
↳ createdOn | string | Account creation timestamp |
↳ selfUrl | string | Account API URL |
↳ htmlUrl | string | Account web URL |
↳ avatarUrl | string | Account avatar URL |
↳ repositoryFullName | string | Repository full name |
↳ target | object | Pipeline target |
↳ type | string | Target object type |
↳ refType | string | Reference type |
↳ refName | string | Reference name |
↳ commitHash | string | Target commit hash |
↳ selectorType | string | Pipeline selector type |
↳ selectorPattern | string | Pipeline selector pattern |
↳ triggerType | string | Pipeline trigger object type |
↳ state | object | Pipeline state |
↳ name | string | State name |
↳ stage | string | In-progress stage name |
↳ result | string | Completed result name |
↳ errorKey | string | Completed-error key |
↳ errorMessage | string | Completed-error message |
↳ createdOn | string | Creation timestamp |
↳ completedOn | string | Completion timestamp |
↳ buildSecondsUsed | number | Build seconds used |
↳ selfUrl | string | Pipeline API URL |
↳ stepsUrl | string | Pipeline steps API URL |
Stop a running pipeline
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
pipelineUuid | string | Yes | Pipeline UUID |
| Parameter | Type | Description |
|---|
stopped | boolean | Whether the stop request succeeded |
List the steps in a pipeline
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
pipelineUuid | string | Yes | Pipeline UUID |
nextUrl | string | No | Opaque next-page URL returned by a previous Bitbucket call |
pageLen | number | No | Results per page (1-100) |
| Parameter | Type | Description |
|---|
page | object | Pagination information |
↳ size | number | Total result count reported by Bitbucket |
↳ page | number | Current page number |
↳ pageLen | number | Number of results requested per page |
↳ nextUrl | string | Validated URL for the next page |
↳ previousUrl | string | Validated URL for the previous page |
items | array | Pipeline steps |
↳ type | string | Bitbucket pipeline-step object type |
↳ uuid | string | Pipeline step UUID |
↳ startedOn | string | Step start timestamp |
↳ completedOn | string | Step completion timestamp |
↳ state | object | Pipeline step state |
↳ name | string | State name |
↳ result | string | Completed result name |
↳ errorKey | string | Completed-error key |
↳ errorMessage | string | Completed-error message |
↳ imageName | string | Build container image name |
↳ setupCommands | array | Setup commands |
↳ name | string | Command name |
↳ command | string | Executable command |
↳ scriptCommands | array | Build script commands |
↳ name | string | Command name |
↳ command | string | Executable command |
Read a bounded UTF-8 tail of a pipeline step log
| Parameter | Type | Required | Description |
|---|
workspaceSlug | string | Yes | Bitbucket workspace slug or UUID |
repoSlug | string | Yes | Bitbucket repository slug or UUID |
pipelineUuid | string | Yes | Pipeline UUID |
stepUuid | string | Yes | Pipeline step UUID |
maxCharacters | number | No | Maximum trailing log characters to return (1-200000) |
| Parameter | Type | Description |
|---|
log | string | Bounded trailing UTF-8 log text |
truncated | boolean | Whether earlier log output was omitted |
totalBytes | number | Full log byte size when reported |
A Trigger is a block that starts a workflow when an event happens in this service.
Trigger workflow when a build status is created for a Bitbucket commit
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
commitStatus | json | Bitbucket commit status object |
commitHash | string | Hash of the commit with this status |
statusKey | string | Key identifying the build status |
statusState | string | Current build status state |
statusName | string | Display name of the build status |
statusUrl | string | URL associated with the build status |
Trigger workflow when a build status is updated for a Bitbucket commit
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
commitStatus | json | Bitbucket commit status object |
commitHash | string | Hash of the commit with this status |
statusKey | string | Key identifying the build status |
statusState | string | Current build status state |
statusName | string | Display name of the build status |
statusUrl | string | URL associated with the build status |
Trigger workflow when a comment is created on a Bitbucket commit
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
comment | json | Bitbucket comment object |
commentId | number | Repository-scoped comment ID |
commentContent | string | Raw text content of the comment |
commit | json | Commit the comment was created on |
Trigger workflow when approval is removed from a Bitbucket pull request
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
approval | json | Pull request approval details |
Trigger workflow when a Bitbucket pull request is approved
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
approval | json | Pull request approval details |
Trigger workflow when a changes request is removed from a Bitbucket pull request
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
changesRequest | json | Pull request changes-request details |
Trigger workflow when changes are requested on a Bitbucket pull request
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
changesRequest | json | Pull request changes-request details |
Trigger workflow when a comment is created on a Bitbucket pull request
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
comment | json | Bitbucket comment object |
commentId | number | Repository-scoped comment ID |
commentContent | string | Raw text content of the comment |
Trigger workflow when a comment is deleted from a Bitbucket pull request
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
comment | json | Bitbucket comment object |
commentId | number | Repository-scoped comment ID |
commentContent | string | Raw text content of the comment |
Trigger workflow when a resolved comment is reopened on a Bitbucket pull request
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
comment | json | Bitbucket comment object |
commentId | number | Repository-scoped comment ID |
commentContent | string | Raw text content of the comment |
Trigger workflow when a comment is resolved on a Bitbucket pull request
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
comment | json | Bitbucket comment object |
commentId | number | Repository-scoped comment ID |
commentContent | string | Raw text content of the comment |
Trigger workflow when a comment is updated on a Bitbucket pull request
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
comment | json | Bitbucket comment object |
commentId | number | Repository-scoped comment ID |
commentContent | string | Raw text content of the comment |
Trigger workflow when a Bitbucket pull request is created
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
Trigger workflow when a Bitbucket pull request is declined
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
Trigger workflow when a Bitbucket pull request is merged
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
Trigger workflow when a Bitbucket pull request is updated
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
pullRequest | json | Bitbucket pull request object |
pullRequestId | number | Repository-scoped pull request ID |
pullRequestTitle | string | Pull request title |
pullRequestState | string | Pull request state |
sourceBranch | string | Pull request source branch |
destinationBranch | string | Pull request destination branch |
Trigger workflow when commits are pushed to a Bitbucket repository
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
push | json | Push details, including changes and commits |
Trigger workflow when a Bitbucket repository is forked
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
fork | json | Newly created repository fork |
Trigger workflow when a Bitbucket repository is updated
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The Bitbucket account used to create and remove the repository webhook. Repository administrator access is required. |
workspacePicker | project-selector | Yes | The workspace containing the repository to monitor. |
workspaceSlugInput | string | Yes | Enter the workspace slug directly instead of selecting a workspace. |
repositoryPicker | project-selector | Yes | The repository where Sim creates the webhook. |
repositorySlugInput | string | Yes | Enter the repository slug directly instead of selecting a repository. |
| Parameter | Type | Description |
|---|
eventType | string | Bitbucket event key from X-Event-Key |
hookUuid | string | UUID of the Bitbucket repository webhook |
requestUuid | string | Bitbucket delivery request UUID |
attemptNumber | number | Bitbucket delivery attempt number |
actor | json | User or app that caused the event |
repository | json | Repository where the event occurred |
payload | json | Full parsed Bitbucket webhook payload |
changes | json | Repository fields changed by the update |
Sim requests these scopes when someone connects a Bitbucket account. On a self-hosted deployment, register your own app with the provider using the settings below. See Integrations & OAuth for the full setup.
| Setting | Value |
|---|
| Redirect URI | <NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/bitbucket |
| Environment variables | BITBUCKET_CLIENT_ID, BITBUCKET_CLIENT_SECRET |
| Scope | Description |
|---|
account | View your Bitbucket account and workspace memberships |
repository | View repositories and source code |
repository:write | Push to repositories and create or delete branches |
pullrequest | View and comment on pull requests |
pullrequest:write | Create, update, approve, decline, and merge pull requests |
pipeline | View pipelines, steps, and logs |
pipeline:write | Run and stop pipelines |
webhook | Manage repository webhooks |