Last updated Jul 16, 2025

Branch

The Branch object type represents a branch object within a repository. atlassian:branch should be used to ingest branch-specific fields.

Payload structure

1
2
  object
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Required]
  ├─ description (string) [Optional]
  ├─ url (string) [Required]
  ├─ createdAt (string) [Required]
  └─ createdBy  [Optional]
      ├─ accountId (string)
      └─ ari (string)
  └─ lastUpdatedAt (string) [Required]
  └─ lastUpdatedBy [Required]
      ├─ accountId (string)
      └─ ari
  └─ containerKey [Optional]
      ├─ type
      ├─ value
      └─ repositoryId
  └─ permissions [] [Required]
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:branch
  ├─ name (string) [Optional]
  └─ lastCommit [Optional]
     ├─ id (string) [Required]
     ├─ displayId (string) [Optional]
     ├─ authorTimestamp (string) [Optional]
     └─ message (string) [Optional]
  └─ createPullRequestUrl (string) [Optional]

You may send the container repository as a separate entity in the same payload or in a separate request.

Common properties

Property	Type	Required	Description
`schemaVersion`	`string`	Yes	The schema version of the object.
`id`	`string`	Yes	The ID of the object in the source system.
`updateSequenceNumber`	`long`	Yes	A sequence number to compare when writing to the database. Objects are written following a last write wins strategy, therefore an object with a greater `UpdateSequenceNumber` is considered a more recently updated object.
`displayName`	`string`	Yes	The display name of the object.
`description`	`string`	No	The description of the object.
`url`	`string`	Yes	The URL from the provider which the object is accessible from.
`createdAt`	`string`	Yes	The date the object was created. Format: Instant (ISO8601 / RFC3339)
`createdBy`	`user`	No	The user that created the object. See User to learn more.
`lastUpdatedAt`	`string`	Yes	The date the object was last updated. Format: Instant (ISO8601 / RFC3339)
`lastUpdatedBy`	`user`	No	The user that last updated the object. See User to learn more.
`owners`	`list<User>`	No	List of users that own the object.
`thumbnail`	`thumbnail`	No	The thumbnail of the object. See Thumbnail to learn more.
`parentKey`	`entityKey`	No	The ID of the parent object. If null, it is a standalone object. See Entity key to learn more.
`containerKey`	`entityKey`	Yes	The container identifier that this object belongs to. See Entity key to learn more.
`permissions`	`list<Permissions>`	Yes	The permissions configuration of the object. See Permissions to learn more.
`associations`	`association`	No	List of objects associated with the object. Generally used to link an external object to a Atlassian object. See Association to learn more.

Branch properties

Property Type Required Description

Property	Type	Required	Description
`name`	`string`	No	The name of the branch. Maximum length: 255
`lastCommit`	`Commit`	No	Information about the last commit on this branch.
`createPullRequestUrl`	`string`	No	URL to create a pull request from this branch.

name

string

The name of the branch.

Maximum length: 255

lastCommit

Commit

Information about the last commit on this branch.

createPullRequestUrl

string

URL to create a pull request from this branch.

Example payload

1
2
{
  "objects" : [ {
    "id" : "repo-1",
    "updateSequenceNumber" : 1,
    "displayName" : "My Repository",
    "description" : "This is a test repository",
    "url" : "https://bitbucket.org/myproject/myrepo/src/master/",
    "lastUpdatedAt" : "2023-07-19T15:27:37.000Z",
    "atlassian:repository" : {
      "forkOf" : "repo-2",
      "avatar" : "avatar.png",
      "avatarDescription" : "something cool idk"
    }
  }, {
    "id" : "branch-1",
    "updateSequenceNumber" : 1,
    "displayName" : "SAI-123-a-branch",
    "description" : "A working branch",
    "url" : "https://bitbucket.org/myproject/myrepo/src/master/",
    "lastUpdatedAt" : "2023-07-19T15:27:37.000Z",
    "containerKey" : {
      "type" : "atlassian:repository",
      "value" : {
        "repositoryId" : "repo-1"
      }
    },
    "atlassian:branch" : {
      "createPullRequestUrl" : "https://url.com",
      "lastCommit" : {
        "id" : "commit-1",
        "updateSequenceNumber" : 1,
        "displayName" : "deadbeef",
        "description" : "SAI-123 A commit that fixes things",
        "url" : "https://bitbucket.org/myproject/myrepo/src/master/",
        "lastUpdatedAt" : "2023-07-19T15:27:37.000Z",
        "containerKey" : {
          "type" : "atlassian:repository",
          "value" : {
            "repositoryId" : "repo-1"
          }
        },
        "owners" : [ {
          "externalId" : "external-id-1",
          "email" : "user@userdomain.com"
        } ],
        "atlassian:commit" : {
          "flags" : [ "MERGE_COMMIT" ],
          "fileCount" : 34,
          "files" : [ {
            "path" : "a/b/c",
            "url" : "https://url.com/a/b/c",
            "changeType" : "ADDED",
            "linesAdded" : 23,
            "linesRemoved" : 0
          } ]
        }
      }
    }
  } ],
  "operationType" : "NORMAL"
}