Bitbucket events

Forge apps can subscribe to Bitbucket events for:

• Repositories
• Pull requests

Your Forge app must have permission from the workspace admin to access the data it provides within the event payload. The OAuth scope required for each event is documented below.

Repository events

You can subscribe to these Bitbucket repository events in Forge apps:

• Created: avi:bitbucket:created:repository
• Updated: avi:bitbucket:updated:repository
• Pushed: avi:bitbucket:push:repository
• Deleted: avi:bitbucket:deleted:repository

Each event has a different payload format.

Repository created

An event with the name avi:bitbucket:created:repository is sent when a repository is created.

The required OAuth scope is read:repository:bitbucket.

Payload

Type reference

1
2
interface Actor {
  type: string;
  accountId: string;
  uuid: string;
}

interface BitbucketResource {
  uuid: string;
}

Example

This is an example payload of a newly created repository.

1
2
{
  "actor": {
    "type": "user",
    "accountId": "5ffed3379edf280075d75b20",
    "uuid": "{cc8e193d-7603-4dfd-8771-fcc8960aa0fb}"
  },
  "repository": {
    "uuid": "{15a31549-1cff-45dc-9d0d-310114c5038b}"
  },
  "project": {
    "uuid": "{1860e69a-65c1-4ac2-8ab0-cbd2868e7573}"
  },
  "workspace": {
    "uuid": "{4c16a397-8e48-479c-8ca2-442e46c90570}"
  },
  "eventType": "avi:bitbucket:created:repository"
}

Repository updated

An event with the name avi:bitbucket:updated:repository is sent when a repository is updated.

The required OAuth scope is read:repository:bitbucket.

Payload

Type reference

1
2
interface Actor {
  type: string;
  accountId: string;
  uuid: string;
}

interface BitbucketResource {
  uuid: string;
}

interface TruncatedValue {
  value: string;
  truncated: boolean;
}

interface Changes {
  [key: string]: {
    old: TruncatedValue;
    new: TruncatedValue;
  };
}

Example

This is an example payload of an updated repository.

1
2
{
  "actor": {
    "type": "user",
    "accountId": "5ffed3379edf280075d75b20",
    "uuid": "{cc8e193d-7603-4dfd-8771-fcc8960aa0fb}"
  },
  "repository": {
    "uuid": "{15a31549-1cff-45dc-9d0d-310114c5038b}"
  },
  "project": {
    "uuid": "{1860e69a-65c1-4ac2-8ab0-cbd2868e7573}"
  },
  "workspace": {
    "uuid": "{4c16a397-8e48-479c-8ca2-442e46c90570}"
  },
  "changes": {
    "description": {
      "old": {
        "value": "",
        "truncated": false
      },
      "new": {
        "value": "New description",
        "truncated": false
      }
    }
  },
  "eventType": "avi:bitbucket:updated:repository",
}

Repository pushed

An event with the name avi:bitbucket:push:repository is sent when source code is being pushed onto a repository.

The required OAuth scope is read:repository:bitbucket.

Payload

Type reference

1
2
interface Actor {
  type: string;
  accountId: string;
  uuid: string;
}

interface BitbucketResource {
  uuid: string;
}

interface TruncatedValue {
  value: string;
  truncated: boolean;
}

interface Commit {
  hash: string;
  message: TruncatedValue;
  date: string;
  author: Actor;
}

interface CommitPush {
  ref: string;
  before: string | null;
  after: string | null;
  created: boolean;
  closed: boolean;
  forced: boolean;
  truncated: boolean;
  commits: Commit[];
}

interface TagPush {
  date: string | null;
  message: TruncatedValue | null;
  author: Actor | null;
}

type Push = CommitPush | TagPush;

Example

This is an example payload of source code being pushed onto a repository.

1
2
{
  "actor": {
    "type": "user",
    "accountId": "5ffed3379edf280075d75b20",
    "uuid": "{cc8e193d-7603-4dfd-8771-fcc8960aa0fb}"
  },
  "repository": {
    "uuid": "{15a31549-1cff-45dc-9d0d-310114c5038b}"
  },
  "project": {
    "uuid": "{1860e69a-65c1-4ac2-8ab0-cbd2868e7573}"
  },
  "workspace": {
    "uuid": "{4c16a397-8e48-479c-8ca2-442e46c90570}"
  },
  "push": {
    "ref": "main",
    "before": null,
    "after": "a37e0ad81173c7f6707d6b9f74dab4ce9938064d",
    "created": true,
    "closed": false,
    "forced": false,
    "truncated": false,
    "commits": [
      {
        "hash": "a37e0ad81173c7f6707d6b9f74dab4ce9938064d",
        "message": {
          "value": "Initial commit",
          "truncated": false
        },
        "date": "2023-05-12T01:40:22.000000Z",
        "author": {
          "user": {
            "type": "user",
            "accountId": "5ffed3379edf280075d75b20",
            "uuid": "{cc8e193d-7603-4dfd-8771-fcc8960aa0fb}"
          }
        }
      }
    ]
  },
  "eventType": "avi:bitbucket:push:repository"
}

Repository deleted

An event with the name avi:bitbucket:deleted:repository is sent when a repository is deleted.

The required OAuth scope is read:repository:bitbucket.

Payload

Type reference

1
2
interface Actor {
  type: string;
  accountId: string;
  uuid: string;
}

interface BitbucketResource {
  uuid: string;
}

Example

This is an example payload of a repository being deleted.

1
2
{
  "actor": {
    "type": "user",
    "accountId": "5ffed3379edf280075d75b20",
    "uuid": "{cc8e193d-7603-4dfd-8771-fcc8960aa0fb}"
  },
  "repository": {
    "uuid": "{15a31549-1cff-45dc-9d0d-310114c5038b}"
  },
  "project": {
    "uuid": "{1860e69a-65c1-4ac2-8ab0-cbd2868e7573}"
  },
  "workspace": {
    "uuid": "{4c16a397-8e48-479c-8ca2-442e46c90570}"
  },
  "eventType": "avi:bitbucket:deleted:repository"
}

Pull request events

You can subscribe to these Bitbucket pull request events in Forge apps:

• Created: avi:bitbucket:created:pullrequest
• Updated: avi:bitbucket:updated:pullrequest
• Fulfilled: avi:bitbucket:fulfilled:pullrequest
• Rejected: avi:bitbucket:rejected:pullrequest
• Comment created: avi:bitbucket:created:pullrequest-comment
• Comment updated: avi:bitbucket:updated:pullrequest-comment
• Comment deleted: avi:bitbucket:deleted:pullrequest-comment

Each event has a different payload format.

Pull request created

An event with the name avi:bitbucket:created:pullrequest is sent when a pull request is created.

The required OAuth scope is read:pullrequest:bitbucket.

Payload

Type reference

1
2
interface Actor {
  type: string;
  accountId: string;
  uuid: string;
}

interface BitbucketResource {
  uuid: string;
}

interface Branch {
  branch: string;
  commit: {
    hash: string;
  };
}

interface PullRequest {
  id: number;
  state: string;
  source: Branch;
  destination: Branch;
}

Example

This is an example payload of a pull request being created.

1
2
{
  "actor": {
    "type": "user",
    "accountId": "5ffed3379edf280075d75b20",
    "uuid": "{cc8e193d-7603-4dfd-8771-fcc8960aa0fb}"
  },
  "repository": {
    "uuid": "{15a31549-1cff-45dc-9d0d-310114c5038b}"
  },
  "project": {
    "uuid": "{1860e69a-65c1-4ac2-8ab0-cbd2868e7573}"
  },
  "workspace": {
    "uuid": "{4c16a397-8e48-479c-8ca2-442e46c90570}"
  },
  "pullrequest": {
    "id": 3,
    "state": "OPEN",
    "source": {
      "branch": "Joshua-Tang/gitignore-edited-online-with-bitbucket-1683871668235",
      "commit": {
        "hash": "cc2758d231fc"
      }
    },
    "destination": {
      "branch": "master",
      "commit": {
        "hash": "a37e0ad81173"
      }
    }
  },
  "eventType": "avi:bitbucket:created:pullrequest"
}

Pull request updated

An event with the name avi:bitbucket:updated:pullrequest is sent when a pull request is updated.

The required OAuth scope is read:pullrequest:bitbucket.

Payload

Type reference

1
2
interface Actor {
  type: string;
  accountId: string;
  uuid: string;
}

interface BitbucketResource {
  uuid: string;
}

interface Branch {
  branch: string;
  commit: {
    hash: string;
  };
}

interface PullRequest {
  id: number;
  state: string;
  source: Branch;
  destination: Branch;
}

Example

This is an example payload of a pull request being updated.

1
2
{
  "actor": {
    "type": "user",
    "accountId": "5ffed3379edf280075d75b20",
    "uuid": "{cc8e193d-7603-4dfd-8771-fcc8960aa0fb}"
  },
  "repository": {
    "uuid": "{15a31549-1cff-45dc-9d0d-310114c5038b}"
  },
  "project": {
    "uuid": "{1860e69a-65c1-4ac2-8ab0-cbd2868e7573}"
  },
  "workspace": {
    "uuid": "{4c16a397-8e48-479c-8ca2-442e46c90570}"
  },
  "pullrequest": {
    "id": 3,
    "state": "OPEN",
    "source": {
      "branch": "Joshua-Tang/gitignore-edited-online-with-bitbucket-1683871668235",
      "commit": {
        "hash": "cc2758d231fc"
      }
    },
    "destination": {
      "branch": "master",
      "commit": {
        "hash": "a37e0ad81173"
      }
    }
  },
  "eventType": "avi:bitbucket:updated:pullrequest"
}

Pull request fulfilled

An event with the name avi:bitbucket:fulfilled:pullrequest is sent when a pull request is merged.

The required OAuth scope is read:pullrequest:bitbucket.

Payload

Type reference

1
2
interface Actor {
  type: string;
  accountId: string;
  uuid: string;
}

interface BitbucketResource {
  uuid: string;
}

interface Hash {
  hash: string;
}

interface Branch {
  branch: string;
  commit: Hash;
}

interface PullRequest {
  id: number;
  state: string;
  source: Branch;
  destination: Branch;
  mergeCommit: Hash;
}

Example

This is an example payload of a pull request being merged.

1
2
{
  "actor": {
    "type": "user",
    "accountId": "5ffed3379edf280075d75b20",
    "uuid": "{cc8e193d-7603-4dfd-8771-fcc8960aa0fb}"
  },
  "repository": {
    "uuid": "{15a31549-1cff-45dc-9d0d-310114c5038b}"
  },
  "project": {
    "uuid": "{1860e69a-65c1-4ac2-8ab0-cbd2868e7573}"
  },
  "workspace": {
    "uuid": "{4c16a397-8e48-479c-8ca2-442e46c90570}"
  },
  "pullrequest": {
    "id": 3,
    "state": "MERGED",
    "source": {
      "branch": "Joshua-Tang/gitignore-edited-online-with-bitbucket-1683871668235",
      "commit": {
        "hash": "cc2758d231fc"
      }
    },
    "destination": {
      "branch": "master",
      "commit": {
        "hash": "a37e0ad81173"
      }
    },
    "mergeCommit": {
      "hash": "71e4ecfcd2ba"
    }
  },
  "eventType": "avi:bitbucket:fulfilled:pullrequest"
}

Pull request rejected

An event with the name avi:bitbucket:rejected:pullrequest is sent when a pull request is declined.

The required OAuth scope is read:pullrequest:bitbucket.

Payload

Type reference

1
2
interface Actor {
  type: string;
  accountId: string;
  uuid: string;
}

interface BitbucketResource {
  uuid: string;
}

interface Hash {
  hash: string;
}

interface Branch {
  branch: string;
  commit: Hash;
}

interface PullRequest {
  id: number;
  state: string;
  source: Branch;
  destination: Branch;
  mergeCommit: Hash;
}

Example

This is an example payload of a pull request being declined.

1
2
{
  "actor": {
    "type": "user",
    "accountId": "5ffed3379edf280075d75b20",
    "uuid": "{cc8e193d-7603-4dfd-8771-fcc8960aa0fb}"
  },
  "repository": {
    "uuid": "{15a31549-1cff-45dc-9d0d-310114c5038b}"
  },
  "project": {
    "uuid": "{1860e69a-65c1-4ac2-8ab0-cbd2868e7573}"
  },
  "workspace": {
    "uuid": "{4c16a397-8e48-479c-8ca2-442e46c90570}"
  },
  "pullrequest": {
    "id": 2,
    "state": "DECLINED",
    "source": {
      "branch": "Joshua-Tang/gitignore-edited-online-with-bitbucket-1683871668235",
      "commit": {
        "hash": "cc2758d231fc"
      }
    },
    "destination": {
      "branch": "master",
      "commit": {
        "hash": "a37e0ad81173"
      }
    }
  },
  "eventType": "avi:bitbucket:rejected:pullrequest"
}

Pull request comment created

An event with the name avi:bitbucket:created:pullrequest-comment is sent when a pull request comment is created.

The required OAuth scope is read:pullrequest:bitbucket.

Payload

Type reference

1
2
interface Actor {
  type: string;
  accountId: string;
  uuid: string;
}

interface BitbucketResource {
  uuid: string;
}

interface Hash {
  hash: string;
}

interface Branch {
  branch: string;
  commit: Hash;
}

interface PullRequest {
  id: number;
  state: string;
  source: Branch;
  destination: Branch;
}

interface Comment {
  id: number;
}

Example

This is an example payload of a pull request comment being created.

1
2
{
    "timestamp": "2023-06-26T06:34:41.624814Z",
    "actor": {
      "type": "user",
      "accountId": "5ebbbc49ad226b0ba4518e11",
      "uuid": "{b0670c4c-4b6c-4f89-b47c-be2de5a64d58}"
    },
    "repository": {
      "uuid": "{30cbb1be-00da-425d-b3b1-29695ceb11f9}"
    },
    "project": {
      "uuid": "{7805fc96-8fee-4a5c-91e5-457368075853}"
    },
    "workspace": {
      "uuid": "{6d1a0dc3-2eb4-4bdc-952f-af3b8fcbe13d}"
    },
    "pullrequest": {
      "id": 4,
      "state": "OPEN",
      "source": {
        "branch": "testbranch1",
        "commit": {
          "hash": "ea92ba633eac"
        }
      },
      "destination": {
        "branch": "master",
        "commit": {
          "hash": "ec8950c039c0"
        }
      }
    },
    "comment": {
      "id": 406336310
    },
    "eventType": "avi:bitbucket:created:pullrequest-comment"
}

Pull request comment updated

An event with the name avi:bitbucket:updated:pullrequest-comment is sent when a pull request comment is updated 10 or more minutes after the comment was created or last updated.

The required OAuth scope is read:pullrequest:bitbucket.

Payload

Type reference

1
2
interface Actor {
  type: string;
  accountId: string;
  uuid: string;
}

interface BitbucketResource {
  uuid: string;
}

interface Hash {
  hash: string;
}

interface Branch {
  branch: string;
  commit: Hash;
}

interface PullRequest {
  id: number;
  state: string;
  source: Branch;
  destination: Branch;
}

interface Comment {
  id: number;
}

Example

This is an example payload of a pull request comment being updated.

1
2
{
    "timestamp": "2023-06-26T06:33:54.051247Z",
    "actor": {
        "type": "user",
        "accountId": "5ebbbc49ad226b0ba4518e11",
        "uuid": "{b0670c4c-4b6c-4f89-b47c-be2de5a64d58}"
    },
    "repository": {
        "uuid": "{30cbb1be-00da-425d-b3b1-29695ceb11f9}"
    },
    "project": {
        "uuid": "{7805fc96-8fee-4a5c-91e5-457368075853}"
    },
    "workspace": {
        "uuid": "{6d1a0dc3-2eb4-4bdc-952f-af3b8fcbe13d}"
    },
    "pullrequest": {
        "id": 4,
        "state": "OPEN",
        "source": {
            "branch": "testbranch1",
            "commit": {
                "hash": "ea92ba633eac"
            }
        },
        "destination": {
            "branch": "master",
            "commit": {
                "hash": "ec8950c039c0"
            }
        }
    },
    "comment": {
        "id": 398501799
    },
    "changes": {
        "content": {}
    },
    "eventType": "avi:bitbucket:updated:pullrequest-comment"
}

Pull request comment deleted

An event with the name avi:bitbucket:deleted:pullrequest-comment is sent when a pull request comment is deleted.

The required OAuth scope is read:pullrequest:bitbucket.

Payload

Type reference

1
2
interface Actor {
  type: string;
  accountId: string;
  uuid: string;
}

interface BitbucketResource {
  uuid: string;
}

interface Hash {
  hash: string;
}

interface Branch {
  branch: string;
  commit: Hash;
}

interface PullRequest {
  id: number;
  state: string;
  source: Branch;
  destination: Branch;
}

interface Comment {
  id: number;
}

Example

This is an example payload of a pull request comment being deleted.

1
2
{
    "timestamp": "2023-06-26T06:35:15.832298Z",
    "actor": {
        "type": "user",
        "accountId": "5ebbbc49ad226b0ba4518e11",
        "uuid": "{b0670c4c-4b6c-4f89-b47c-be2de5a64d58}"
    },
    "repository": {
        "uuid": "{30cbb1be-00da-425d-b3b1-29695ceb11f9}"
    },
    "project": {
        "uuid": "{7805fc96-8fee-4a5c-91e5-457368075853}"
    },
    "workspace": {
        "uuid": "{6d1a0dc3-2eb4-4bdc-952f-af3b8fcbe13d}"
    },
    "pullrequest": {
        "id": 4,
        "state": "OPEN",
        "source": {
        "branch": "testbranch1",
        "commit": {
            "hash": "ea92ba633eac"
        }
        },
        "destination": {
        "branch": "master",
        "commit": {
            "hash": "ec8950c039c0"
        }
        }
    },
    "comment": {
        "id": 406336310
    },
    "eventType": "avi:bitbucket:deleted:pullrequest-comment",
}