Product events

Product events

Product events are generated when users perform actions in Atlassian products. App's can subscribe to a list of product events using a trigger in the manifest.

Event format

Events comprise a name and a payload.

name: Use the name to subscribe to events in the manifest.
payload: Use the payload in your app function.

Event name

Event names follow the format: avi:activity:<eventType>:<objectType>.

eventType: The type of event that occurred. For example, assigned, viewed, or liked.
objectType: The type of object the event occurred to. For example, project, issue, or page.

Event payload

The table below describes the fields contained in an event payload.

Field	Type	Description
`accountId`	`string`	User ID
`activityItem.eventType`	`enum`	Event type
`activityItem.object`	`ActivityObject`	Object (issue, page and alike)
`activityItem.object.id`	`string`	Object ID
`activityItem.object.name`	`string`	Object name
`activityItem.object.type`	`enum`	Object type
`activityItem.object.product`	`enum`	Object product
`activityItem.object.url` and `activityItem.object.iconUrl`	`string`	Object URLs (url, restUrl, iconUrl)
`activityItem.containers`	`Array<ActivityObject>`	A list of containers associated with the object
`activityItem.contributors`	`Array<ActivityContributor>`	List of contributors

Example payload

{
  "type": "avi:activity:viewed:issue",
  "schema": "ari:cloud:platform-services::worklens/activity",
  "payload": {
    "accountId": "7407998c-6003-42e1-b1db-6f62ee9455bf",
    "activityItem": {
      "id": "YXJpOmNsb3VkOmFjdGl2aXR5OmFmNzZkOGE0LWM3OTQtNDk4Yy05NzMxLWMyMTQ4ODc5YzRiZjppdGVtL1lYSnBPbU5zYjNWa09tcHBjbUU2WVdZM05tUTRZVFF0WXpjNU5DMDBPVGhqTFRrM016RXRZekl4TkRnNE56bGpOR0ptT21semMzVmxMelEwT0RCOE1qQXhPUzB3T0MweE5WUXdOem93TURvMU9TNDJNREphZkZaSlJWZEZSQT09",
      "timestamp": "2019-08-15T07:00:59.602Z",
      "eventType": "VIEWED",
      "object": {
        "id": "YXJpOmNsb3VkOmppcmE6YWY3NmQ4YTQtYzc5NC00OThjLTk3MzEtYzIxNDg4NzljNGJmOmlzc3VlLzQ0ODA=",
        "localResourceId": "4480",
        "name": "KEY-789 There is an issue with 4480",
        "type": "ISSUE",
        "product": "JIRA",
        "cloudID": "af76d8a4-c794-498c-9731-c2148879c4bf",
        "url": "https://example.atlassian.net/browse/KEY-789",
        "iconURL": "https://example.com/icon.svg"
      },
      "containers": [
        {
          "id": "YWY3NmQ4YTQtYzc5NC00OThjLTk3MzEtYzIxNDg4NzljNGJm",
          "localResourceId": "af76d8a4-c794-498c-9731-c2148879c4bf",
          "type": "SITE",
          "product": "JIRA",
          "cloudID": "af76d8a4-c794-498c-9731-c2148879c4bf",
          "url": "https://example.atlassian.net"
        },
        {
          "id": "YXJpOmNsb3VkOmppcmE6YWY3NmQ4YTQtYzc5NC00OThjLTk3MzEtYzIxNDg4NzljNGJmOnByb2plY3QvNjE4",
          "localResourceId": "618",
          "name": "project",
          "type": "PROJECT",
          "product": "JIRA",
          "cloudID": "af76d8a4-c794-498c-9731-c2148879c4bf",
          "url": "https://example.atlassian.net/projects/KEY"
        }
      ],
      "contributors": [
          {
              "profile": {
                  "accountId": "123057:5cb5312f-1136-422f-92f7-b077349b5xyz"
              }
          },
          {
              "profile": {
                  "accountId": "123057:711ade1d-30f7-4568-b36b-844f96bf942a"
              }
          }
      ]
    }
  },
  "resource": "ari:cloud:jira:af76d8a4-c794-498c-9731-c2148879c4bf:issue/4480"
}

Jira events

Forge apps can subscribe to these Jira events.

Event name	Description
`avi:activity:created:issue`	An issue was created
`avi:activity:updated:issue`	An issue was updated
`avi:activity:viewed:issue`	An issue was viewed
`avi:activity:assigned:issue`	An issue was assigned
`avi:activity:unassigned:issue`	An issue was unassigned
`avi:activity:transitioned:issue`	An issue’s status was transitioned

Confluence events

Forge apps can subscribe to these Confluence events.

Event name	Description
`avi:activity:published:page`	A page was published
`avi:activity:published:blogpost`	A blogpost was published
`avi:activity:viewed:page`	A page was viewed
`avi:activity:viewed:blogpost`	A blogpost was viewed
`avi:activity:liked:page`	A page was liked
`avi:activity:liked:blogpost`	A blogpost was liked
`avi:activity:commented:page`	A page was commented on
`avi:activity:commented:blogpost`	A blogpost was commented on

Forge Developer