Pull request

The Pull request object type represents Developer Information (DevInfo) pull request entity. atlassian:pull-request should be used to ingest pull request-specific fields.

Payload structure

1
2
  objects {}
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Required]
  ├─ description (string) [Optional]
  ├─ url (string) [Required]
  ├─ createdAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ createdBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ containerKey (EntityKey) [Required]
      ├─ type (string) [Required]
      └─ value (jsonNode) [Required]
  └─ permissions [] [Required] 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []

  atlassian:pull-request
  ├─ title (string) [Optional]
  ├─ displayId (string) [Required]
  ├─ status (string) [Required]
  ├─ author (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  ├─ commentCount (integer) [Optional]
  ├─ sourceBranch (string) [Required]
  ├─ sourceBranchUrl (string) [Optional]
  ├─ destinationBranch (string) [Required]
  ├─ destinationBranchUrl (string) [Optional]
  ├─ reviewers (List<Reviewer>) [Required]
      ├─ accountId (string) [Optional]
      ├─ externalId (string) [Required]
      ├─ email (string) [Optional]
      ├─ approvalStatus (string) [Optional]
      ├─ name (string) [Optional]
      ├─ avatar (string) [Optional]
      ├─ url (string) [Optional]
      └─ ari (string) [Optional]
  └─ taskCount (integer) [Optional]

Common properties

Pull request properties

Example payload

1
2
{
  "objects" : [ {
    "schemaVersion" : "2.0",
    "id" : "repo-1",
    "updateSequenceNumber" : 1,
    "displayName" : "My repository",
    "description" : "A test repository",
    "url" : "https://bitbucket.org/my-project/my-repo/src/master/",
    "lastUpdatedAt" : "2023-07-19T15:27:37.000Z",
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "ATLASSIAN_WORKSPACE"
        } ]
      } ]
    } ],
    "atlassian:repository" : {
      "forkOf" : "repo-2",
      "avatar" : "avatar.png",
      "avatarDescription" : "An avatar"
    }
  }, {
    "schemaVersion" : "2.0",
    "id" : "pr-1",
    "updateSequenceNumber" : 1,
    "displayName" : "SAI-123 A PR to do things",
    "description" : "This Pull request does X, Y, and Z.",
    "url" : "https://bitbucket.org/my-project/my-repo/pull-requests/2",
    "createdAt" : "2023-07-18T10:00:00.000Z",
    "lastUpdatedAt" : "2023-07-19T15:27:37.000Z",
    "containerKey" : {
      "type" : "atlassian:repository",
      "value" : {
        "repositoryId" : "repo-1"
      }
    },
    "owners" : [ {
      "externalId" : "external-id-1",
      "email" : "user4@example.com"
    } ],
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "ATLASSIAN_WORKSPACE"
        } ]
      } ]
    } ],
    "atlassian:pull-request" : {
      "displayId" : "#2",
      "status" : "open",
      "author" : {
        "externalId" : "external-id-1"
      },
      "commentCount" : 324,
      "sourceBranch" : "SAI-123-sdf",
      "destinationBranch" : "main",
      "reviewers" : [ {
        "externalId" : "external-id-2",
        "email" : "user5@example.com",
        "approvalStatus" : "approved"
      } ],
      "taskCount" : 21
    }
  } ]
}