Last updated Jul 16, 2025

Design

The Design object type represents a design artifact object. atlassian:design should be used to ingest design-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:design
  ├─ liveEmbedUrl (string) [Required]
  ├─ inspectUrl (string) [Optional]
  ├─ status (string) [Required]
  ├─ type (string) [Required]
  └─ iconUrl (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.
`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.

Design properties

Property	Type	Required	Description
`liveEmbedUrl`	`string`	Yes	The URL for the live embed of the design.
`inspectUrl`	`string`	No	The URL for inspecting the design in detail.
`status`	`string`	Yes	The current status of the design. Allowed values: `ready_for_development`, `unknown`, `none`
`type`	`string`	Yes	The type of the design. Allowed values: `file`, `canvas`, `group`, `node`, `prototype`, `other`
`iconUrl`	`string`	No	The URL for the design's icon.

Example payload

1
2
{
  "objects" : [ {
    "id" : "design-1",
    "updateSequenceNumber" : 1,
    "displayName" : "My design",
    "description" : "My first design",
    "url" : "https://www.example-design.com/file/XlgwF9hpEiVZHmsToT0ZTU",
    "lastUpdatedAt" : "2023-07-19T15:27:37.000Z",
    "atlassian:design" : {
      "liveEmbedUrl" : "https://example-design.com/embed/1111",
      "status" : "READY_FOR_DEVELOPMENT",
      "type" : "FILE"
    }
  } ],
  "operationType" : "NORMAL"
}