Last updated Jul 16, 2025

Deal

The Deal object type represents a sales deal or opportunity object. atlassian:deal should be used to ingest deal-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:deal
  ├─ contact (UserReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      ├─ externalId (string) [Optional]
      ├─ ari (string) [Optional]
      ├─ name (string) [Optional]
      ├─ userName (string) [Optional]
      ├─ avatar (string) [Optional]
      └─ url (string) [Optional]
  ├─ stage (string) [Optional]
  ├─ status (string) [Optional]
  ├─ accountName (string) [Optional]
  ├─ contributors (List<UserReference>) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      ├─ externalId (string) [Optional]
      ├─ ari (string) [Optional]
      ├─ name (string) [Optional]
      ├─ userName (string) [Optional]
      ├─ avatar (string) [Optional]
      └─ url (string) [Optional]
  ├─ lastActivity (DealLastActivity) [Optional]
      ├─ lastActivityAt (string) [Required]
      └─ event (string) [Required]
  ├─ dealClosedAt (string) [Optional]
  ├─ opportunityAmount (DealOpportunityAmount) [Optional]
      ├─ value (Double) [Required]
      └─ currencyCode (String) [Required]
  └─ isClosed (boolean) [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`	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.

Deal properties

Property	Type	Required	Description
`contact`	`UserReference`	No	The primary contact for the deal.
`stage`	`string`	No	The current stage of the deal.
`status`	`string`	N	The current status of the deal.
`accountName`	`string`	No	The name of the account associated with the deal.
`contributors`	`List<UserReference>`	No	List of contributors associated with the deal.
`lastActivity`	`DealLastActivity`	No	Information about the last activity for the deal.
`lastActivity.lastActivityAt`	`string`	Yes	The timestamp of the last activity. Format: Instant (ISO8601 / RFC3339)
`lastActivity.event`	`string`	Yes	The type of the last activity event.
`dealClosedAt`	`string`	No	The timestamp when the deal was closed. Format: Instant (ISO8601 / RFC3339)
`opportunityAmount`	`DealOpportunityAmount`	No	The monetary opportunity amount for the deal.
`opportunityAmount.value`	`double`	Yes	The monetary value of the opportunity.
`opportunityAmount.currencyCode`	`string`	Yes	The currency code for the opportunity amount (e.g., USD, EUR).
`isClosed`	`boolean`	Yes	Indicates whether the deal is closed.

Example payload

1
2
{
  "objects" : [ {
    "schemaVersion" : "2.0",
    "id" : "deal-1",
    "updateSequenceNumber" : 1,
    "description" : "Fix login issue",
    "url" : "https://deal.example.com/item/1",
    "displayName" : "Deal Name",
    "createdAt" : "2024-04-16T09:31:32+00:00",
    "createdBy" : {
      "email" : "e-mail@user1.com",
      "externalId" : "external-id-1",
      "name" : "John Doe",
      "avatar" : "https://deal.example.com/avatar/31"
    },
    "lastUpdatedAt" : "2024-04-16T09:31:32+00:00",
    "lastUpdatedBy" : {
      "email" : "e-mail@user1.com",
      "externalId" : "external-id-1",
      "name" : "John Doe",
      "avatar" : "https://deal.example.com/avatar/31"
    },
    "permissions" : [ {
      "action" : "read",
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    } ],
    "atlassian:deal" : {
      "contact" : {
        "email" : "e-mail@user1.com",
        "externalId" : "external-id-1",
        "name" : "John Doe",
        "avatar" : "https://deal.example.com/avatar/31"
      },
      "stage" : "In Progress",
      "status" : "In Progress",
      "accountName" : "Deal Name",
      "lastActivityAt" : "2024-04-16T09:31:32+00:00",
      "event" : "Deal Created",
      "dealClosedAt" : "2024-04-16T09:31:32+00:00",
      "value" : 1000.0,
      "currencyCode" : "USD",
      "isClosed" : false,
      "collaborators" : [ {
        "email" : "e-mail@user1.com",
        "externalId" : "external-id-1",
        "name" : "John Doe",
        "avatar" : "https://deal.example.com/avatar/31"
      } ]
    }
  } ],
  "operationType" : "NORMAL"
}