Build

The Build object type represents a build object. atlassian:build should be used to ingest build-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 [] [Optional]
      ├─ accountId (string)
      └─ ari (string)
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy [] [Required]
      ├─accountId (string)
      └─ ari
  └─ containerKey ()[Optional]
      ├─ type
      ├─ value
      └─ repositoryId
  └─ permissions 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:build
  ├─ pipelineId (string) [Required]
  ├─ buildNumber (integer) [Required]
  ├─ label (string) [Optional]
  ├─ state (string) [Required]
  ├─ duration (integer) [Optional]
  └─ testInfo [Optional]
     ├─ totalNumber (integer) [Required]
     ├─ numberPassed (integer) [Required]
     ├─ numberFailed (integer) [Required]
     └─ numberSkipped (integer) [Required]
  └─ references [] [Optional]
     └─ commit [Optional]
        ├─ id (string) [Required]
        └─ repositoryUri (string) [Required]
     └─ ref [Optional]
        ├─ name (string) [Required]
        └─ uri (string) [Required]

Common properties

Build properties

Example payload

1
2
{
  "objects" : [ {
    "schemaVersion" : "2.0",
    "id" : "pipelineId/my-build-plan/buildId/16",
    "updateSequenceNumber" : 1,
    "displayName" : "My Project build #16",
    "description" : "My Project build #16: Failed",
    "url" : "https://build.example.com/1",
    "createdAt" : "2024-07-01T05:00:45Z",
    "createdBy" : {
      "externalId" : "external-id-1"
    },
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "lastUpdatedBy" : {
      "externalId" : "external-id-1"
    },
    "containerKey" : {
      "type" : "atlassian:repository",
      "value" : {
        "repositoryId" : "my-repo-1"
      }
    },
    "permissions" : [ {
      "action" : "read",
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    } ],
    "atlassian:build" : {
      "pipelineId" : "my-build-plan",
      "buildNumber" : 16,
      "label" : "<string>",
      "duration" : 47,
      "state" : "failed",
      "testInfo" : {
        "totalNumber" : 150,
        "numberPassed" : 145,
        "numberFailed" : 5,
        "numberSkipped" : 0
      },
      "references" : [ {
        "commit" : {
          "id" : "08cd9c26b2b8d7cf6e6af6b49da8895d065c259f",
          "repositoryUri" : "https://bitbucket.org/myproject/my-repo"
        },
        "ref" : {
          "name" : "feature/ISSUE-123-some-work",
          "uri" : "https://bitbucket.org/myproject/my-repo/refs/feature/ISSUE-123-some-work"
        }
      } ]
    }
  } ],
  "operationType" : "NORMAL"
}