Last updated Jul 16, 2025

Conversation

The Conversation object type represents a conversation or chat thread object. atlassian:conversation should be used to ingest conversation-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
  └─ permissions 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:conversation
  ├─ type (string) [Required]
  ├─ membershipType (string) [Required]
  ├─ workspace (string) [Required]
  ├─ topic (string) [Optional]
  ├─ isArchived (boolean) [Optional]
  ├─ members (List<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]
  ├─ lastActive (string) [Optional]
  └─ memberCount (integer) [Optional]

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.

Conversation properties

Property	Type	Required	Description
`type`	`string`	Yes	The type of the conversation. Allowed values: `channel`, `direct_message`, `group_direct_message`
`membershipType`	`string`	Yes	The membership type of the conversation. Allowed values: `private`, `public`, `shared`
`workspace`	`string`	Yes	The workspace where the conversation is located. Maximum length: 255
`topic`	`string`	No	The topic or subject of the conversation. Maximum length: 500
`isArchived`	`boolean`	No	Whether the conversation has been archived.
`members`	`List<UserReference>`	Yes	List of members in the conversation. Maximum: 1000 members
`lastActive`	`string`	No	The timestamp of the last activity in the conversation. Format: Instant (ISO8601 / RFC3339)
`memberCount`	`integer`	No	The total number of members in the conversation.

Example payload

1
2
{
  "objects" : [ {
    "id" : "CFG3W7TKJ",
    "updateSequenceNumber" : 1,
    "displayName" : "Some conversation",
    "url" : "https://example-conversation.com/CFG3W7TKJ",
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "lastActive" : "2024-07-09T15:27:37.000Z",
    "permissions" : [ {
      "action" : "read",
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    } ],
    "atlassian:conversation" : {
      "type" : "channel",
      "membershipType" : "public",
      "workspace" : "My Workspace",
      "topic" : "How great is this feature?",
      "members" : [ {
        "id" : "WELLJST6K",
        "email" : "user1@example.com"
      }, {
        "id" : "WEKQSP669"
      } ]
    }
  } ],
  "operationType" : "NORMAL"
}