Last updated Jul 16, 2025

Comment

The Comment object type represents a comment object on artifacts such as pull requests, work items, or documents. atlassian:comment should be used to ingest comment-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
  └─ parentKey ()[Required]
      ├─ type
      └─ value
  └─ permissions 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:comment
  ├─ text (string) [Optional]
  └─ reactionsV2 (List<Reaction>) [Optional]
      ├─ reactionType (string) [Required]
      └─ total (Integer) [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`	Yes	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.

Comment properties

Property	Type	Required	Description
`text`	`string`	No	The text content of the comment.
`reactionsV2`	`List<Reaction>`	No	List of reactions to the comment.
`reactionsV2.reactionType`	`string`	Yes	Allowed values: `LIKE`
`reactionsV2.total`	`integer`	Yes	The total number of users who gave this reaction type.

Example payload

1
2
{
  "objects" : [ {
    "id" : "siteId/commentId1",
    "updateSequenceNumber" : 1,
    "displayName" : "My comment",
    "url" : "https://www.atlassian.com/share/spaceId1",
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "createdBy" : {
      "accountId" : "accountId",
      "ari" : "ari:cloud:identity::third-party-user/abc/123"
    },
    "permissions" : [ {
      "action" : "read",
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    } ],
    "containerKey" : {
      "type" : "atlassian:space",
      "value" : {
        "entityId" : "CFG3W7TKJ"
      }
    },
    "parentKey" : {
      "type" : "atlassian:document",
      "value" : {
        "entityId" : "parent-document"
      }
    },
    "atlassian:comment" : {
      "text" : "comment text",
      "reactionsV2" : [ {
        "reactionType" : "LIKE",
        "total" : 1
      } ]
    }
  } ],
  "operationType" : "NORMAL"
}