Last updated Jul 16, 2025

Remote link

The Remote link object type represents a link between objects in different systems. atlassian:remote-link should be used to ingest remote link-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:remote-link
  ├─ type (string) [Required]
  ├─ status (RemoteLinkStatus) [Optional]
      ├─ appearance (string) [Required]
      └─ label (string) [Required]
  ├─ author (UserReference) [Optional]
  ├─ category (string) [Optional]
  └─ assignee (UserReference) [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`	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.

Remote link properties

Property	Type	Required	Description
`type`	`string`	Yes	The type of the remote link. Allowed values: `document` `alert` `test` `security` `log_file` `prototype` `coverage` `bug_report` `release_notes` `other`
`status`	`RemoteLinkStatus`	No	The status information for the remote link.
`status.appearance`	`string`	Yes	The status visual appearance of the remote link. Allowed values: `default` `in_progress` `moved` `new` `removed` `success`
`status.label`	`string`	Yes	The label text for the status.
`author`	`UserReference`	No	The author of the remote link.
`category`	`string`	No	The category of the remote link.
`assignee`	`UserReference`	No	The assignee of the remote link.

Example payload

1
2
{
  "objects" : [ {
    "id" : "project/63f599e61ef2d72e0fe91b1d/screen/63f599e61ef2d72e0fe91bdb",
    "schemaVersion" : "2.0",
    "updateSequenceNumber" : 1,
    "description" : "A remote link example",
    "url" : "http://example-rl.com",
    "displayName" : "Remote Link Display Name",
    "createdAt" : "2024-04-16T09:31:32+00:00",
    "createdBy" : {
      "externalId" : "external-id-1"
    },
    "lastUpdatedAt" : "2024-04-16T09:31:32+00:00",
    "lastUpdatedBy" : {
      "externalId" : "external-id-1"
    },
    "permissions" : {
      "remotePermissionCheckOnly" : true
    },
    "atlassian:remote-link" : {
      "type" : "document",
      "status" : {
        "appearance" : "removed",
        "label" : "REMVOED"
      },
      "author" : {
        "email" : "some@email.com"
      },
      "category" : "a category"
    }
  } ]
}