Work Item

The Work Item object type represents a task, issue, or any other work entity typically associated with project management or task tracking. atlassian:work-item should be used to ingest work item-specific fields.

Payload structure

1
2
  objects {}
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Required]
  ├─ description (string) [Required]
  ├─ 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]
  └─ owners (List<userReference>) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ thumbnail [Optional]
      └─ externalUrl (string)
  └─ parentKey (EntityKey) [Optional]
      ├─ type (string) [Required]
      └─ value (jsonNode) [Required]
  └─ containerKey (EntityKey) [Optional]
      ├─ type (string) [Required]
      └─ value (jsonNode) [Required]
  └─ permissions [] [Required]
      └─ accessControls
         └─ principals
            └─ type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:work-item
  ├─ dueDate (string) [Optional]
  ├─ assignee (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  ├─ workItemProject (WorkItemProject) [Optional]
      ├─ id (string) [Required]
      └─ name (string) [Required]
  ├─ collaborators (List<userReference>) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  ├─ exceedsMaxCollaborators (boolean) [Optional]
  ├─ status (string) [Required]
  ├─ subtype (string) [Required]
  ├─ attachments (List<Attachment>) [Optional]
      ├─ url (string) [Optional]
      ├─ thumbnailUrl (string) [Optional]
      ├─ title (string) [Optional]
      ├─ mimeType (string) [Optional]
      ├─ byteSize (integer) [Optional]
      └─ fileType (string) [Optional]
  └─ team (string) [Optional]

Common properties

Work item properties

Example payload

1
2
{
  "objects" : [ {
    "schemaVersion" : "2.0",
    "id" : "work-item-1",
    "updateSequenceNumber" : 1,
    "displayName" : "Work Item Name",
    "description" : "Fix login issue",
    "url" : "https://work-item.example.com/item/1",
    "createdAt" : "2024-04-16T09:31:32+00:00",
    "createdBy" : {
      "externalId" : "external-id-1",
      "email" : "user1@example.com"
    },
    "lastUpdatedAt" : "2024-04-16T09:31:32+00:00",
    "lastUpdatedBy" : {
      "externalId" : "external-id-1",
      "email" : "user1@example.com"
    },
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "ATLASSIAN_WORKSPACE"
        } ]
      } ]
    } ],
    "atlassian:work-item" : {
      "dueDate" : "2024-05-01T12:00:00+00:00",
      "assignee" : {
        "externalId" : "external-id-1",
        "email" : "user1@example.com"
      },
      "workItemProject" : {
        "id" : "project-1",
        "name" : "Project A"
      },
      "collaborators" : [ {
        "externalId" : "external-id-1",
        "email" : "user1@example.com"
      } ],
      "exceedsMaxCollaborators" : false,
      "status" : "In Progress",
      "subtype" : "work_item",
      "attachments" : [ {
        "url" : "https://example.com/files/attachment1.png",
        "mimeType" : "image/png",
        "byteSize" : 204800,
        "fileType" : "image"
      } ],
      "team" : "Engineering Team"
    }
  } ]
}