The Message object type represents a message object within conversations or channels. atlassian:message should be used to ingest Message-specific fields.

Additional required fields for Message:

description - Required
containerKey - Required with type atlassian:conversation

Other overrides:

displayName - Not supported
parentKey - When provided, must be type atlassian:message

A Message is contained in a Conversation and can be referred as a parent for another Message.

Payload structure

1
2
  objects {}
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [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]
  └─ parentKey (EntityKey) [Optional]
      ├─ type (string) [Required]
      └─ value (jsonNode) [Required]
  └─ containerKey (EntityKey) [Required]
      ├─ type (string) [Required]
      └─ value (jsonNode) [Required]
  └─ permissions [] [Required] 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:message
  ├─ hidden (boolean) [Optional]
  ├─ isPinned (boolean) [Optional]
  ├─ attachments (List<Attachment>) [Optional]
      ├─ url (string) [Optional]
      ├─ thumbnailUrl (string) [Optional]
      ├─ title (string) [Optional]
      ├─ mimeType (string) [Optional]
      ├─ byteSize (long) [Optional]
      └─ fileType (string) [Optional]
  ├─ links (List<Link>) [Optional]
      └─ url (string) [Optional]
  └─ lastActive (string) [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.
`description`	`string`	Yes	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`	`userReference`	No	A reference to the user that created the object. See userReference to learn more.
`lastUpdatedAt`	`string`	Yes	The date the object was last updated. Format: Instant (ISO8601 / RFC3339)
`lastUpdatedBy`	`userReference`	No	A reference to the user that last updated the object. See userReference to learn more.
`owners`	`list<userReference>`	No	List of references 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`	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.

Message properties

Property	Type	Required	Description
`hidden`	`boolean`	No	Whether the message is hidden from view.
`isPinned`	`boolean`	No	Whether the message is pinned in the conversation.
`attachments`	`List<Attachment>`	No	List of file attachments included with the message.
`attachments.url`	`string`	No	The URL to access the attached file. Format: Valid URL
`attachments.thumbnailUrl`	`string`	No	The URL for the thumbnail of the attachment. Format: Valid URL
`attachments.title`	`string`	No	The title or name of the attachment. Validation: max-length: 255
`attachments.mimeType`	`string`	No	The MIME type of the attached file. Format: Valid MIME Type
`attachments.byteSize`	`long`	No	The size of the attachment in bytes. Format: int64
`attachments.fileType`	`string`	No	The file type of the attachment. Allowed values: `pdf`, `image`, `document`, `presentation`, `spreadsheet`, `video`, `audio`, `other`
`links`	`List<Link>`	No	The links included in the message.
`links.url`	`string`	No	The URL of the link. Format: Valid URL
`lastActive`	`string`	No	The timestamp of the last activity on the message. Format: Instant (ISO8601 / RFC3339)

Example payload

1
2
{
  "objects" : [ {
    "schemaVersion" : "2.0",
    "id" : "message-1",
    "updateSequenceNumber" : 1,
    "description" : "Hello everyone !",
    "url" : "https://example-conversation.com/p1722400000000000",
    "createdAt" : "2024-07-09T10:00:00.000Z",
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "ATLASSIAN_WORKSPACE"
        } ]
      } ]
    } ],
    "containerKey" : {
      "type" : "atlassian:conversation",
      "value" : {
        "entityId" : "CFG3W7TKJ"
      }
    },
    "atlassian:message" : {
      "attachments" : [ {
        "url" : "https://example-conversation.com/attachements/CFG3W7TKJ",
        "mimeType" : "image/png",
        "byteSize" : 140288,
        "fileType" : "image"
      } ],
      "links" : [ {
        "url" : "https://www.google.com"
      } ],
      "lastActive" : "2024-07-09T15:27:37.000Z"
    }
  } ]
}