Lifecycle events

Forge apps can subscribe to their own lifecycle events for:

Installations
Upgrades

Installation

An event with the name avi:forge:installed:app is sent when an app has been installed on a site.

Payload

Name	Type	Description
id	`string`	The ID of the installation.
installerAccountId	`string`	The ID of the user who installed the Forge app. Use the `Get user` operation of either Jira and Confluence REST APIs to retrieve more information about the user.
app	`App`	An object describing the Forge app.

Type reference

1
2
interface App {
  id: string;
  version: string;
}

Example

This is an example payload.

1
2
{
  "id": "fff8e466-31f4-4c73-a337-c3309dd930dc",
  "installerAccountId": "4ad9aa0c52dc1b420a791d12",
  "app": { 
       "id": "406d303d-0393-4ec4-ad7c-1435be94583a", 
       "version": "9.0.0"
    }
}

Upgrade

An event with the name avi:forge:upgraded:app is sent when an installed app on a site has been upgraded to a new major version. This event is not sent for minor or patch version upgrades.

Payload

Name	Type	Description
id	`string`	The ID of the installation.
installerAccountId	`string`	The ID of the user who upgraded the Forge app. Use the `Get user` operation of either Jira and Confluence REST APIs to retrieve more information about the user.
app	`App`	An object describing the Forge app.

Type reference

1
2
interface App {
  id: string;
  version: string;
}

Example

This is an example payload.

1
2
{
  "id": "fff8e466-31f4-4c73-a337-c3309dd930dc",
  "upgraderAccountId": "4ad9aa0c52dc1b420a791d12",
  "app": { 
       "id": "406d303d-0393-4ec4-ad7c-1435be94583a", 
       "version": "9.0.0"
    }
}