Last updated Jul 16, 2025

Worker

The Worker object type represents a worker or employee object. atlassian:worker should be used to ingest worker-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 (string) [Required]
  └─ createdBy [] [Optional]
      ├─ accountId (string)
      └─ ari (string)
  └─ lastUpdatedAt (string) [Required]
  └─ lastUpdatedBy [] [Required]
      ├─accountId (string)
      └─ ari
  └─ permissions 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:worker
  ├─ hiredAt  (string) [Required]
  ├─ workerUser (UserReference) [Required]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      ├─ externalId (string) [Optional]
      ├─ ari (string) [Optional]
      ├─ name (string) [Optional]
      ├─ userName (string) [Optional]
      ├─ avatar (string) [Optional]
      └─ url (string) [Optional]
  └─ customAndSensitiveData (string) [Required]

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`	No	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.

Worker properties

Property	Type	Required	Description
`createdAt`	`string`	Yes	The date the worker was hired. Format: Instant (ISO8601 / RFC3339)
`workerUser`	`UserReference`	Yes	The worker user reference information.
`workerUser.accountId`	`string`	false
`workerUser.email`	`string`	false	The user email address
`workerUser.externalId`	`string`	false	The user ID within the external system.
`workerUser.ari`	`string`	false	Internal Atlassian User ID
`workerUser.name`	`string`	false	The user name
`workerUser.userName`	`string`	false	The username of the user in the external system
`workerUser.avatar`	`string`	false	URL to user avatar
`workerUser.url`	`string`	false	URL to user profile
`customAndSensitiveData`	`string`	Yes	Any additional sensitive data Maximum length: 255

Example payload

1
2
{
  {
    "objects" : [ {
      "id" : "worker-1",
      "updateSequenceNumber" : 1,
      "displayName" : "worker 1",
      "createdAt" : "2024-04-16T09:01:32+00:00",
      "url" : "https://workday.atlassian.com/path-to-the-worker",
      "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
      "permissions" : [ {
        "action" : "read",
        "accessControls" : [ {
          "principals" : [ {
            "type" : "EVERYONE"
          } ]
        } ]
      } ],
      "atlassian:worker" : {
        "hiredAt" : "2024-11-26T03:59:05.199Z",
        "workerUser" : {
          "externalId" : "external-id-1"
        }
      }
    } ],
    "operationType" : "NORMAL"
  }
}