Life Cycle Events
Apps can subscribe to their own lifecycle events for:
- Installations
- Upgrades
- Uninstall
Installation
An event with the name gei:apps:installed:app
is sent when an app has been installed on a site.
Payload
Name | Type | Description |
---|---|---|
event | String | gei:apps:installed:app |
appKey | String | app key |
tenant | String | tenant key |
versionKey | String | version |
environmentKey | String | environment key |
sessionToken | String | user token |
Example
{
"event": "gei:apps:installed:app",
"appKey": "work-hour",
"tenant": "osc",
"versionKey": "1.0",
"environmentKey": "production",
"sessionToken": "r:eeii23498saowewerazf"
}
Upgrade
An event with the name gei:apps:upgraded:app
is sent when an installed app on a site has been upgraded.
Payload
Name | Type | Description |
---|---|---|
event | String | gei:apps:upgraded:app |
appKey | String | app key |
tenant | String | tenant key |
versionKey | String | version |
environmentKey | String | environment key |
sessionToken | String | user token |
Example
{
"event": "gei:apps:upgraded:app",
"appKey": "work-hour",
"tenant": "osc",
"versionKey": "1.0",
"environmentKey": "production",
"sessionToken": "r:eeii23498saowewerazf"
}
Uninstall
An event with the name gei:apps:uninstalled:app
is sent when an uninstalled app on a site has been upgraded.
Payload
Name | Type | Description |
---|---|---|
event | String | gei:apps:uninstalled:app |
appKey | String | app key |
tenant | String | tenant key |
versionKey | String | version |
environmentKey | String | environment key |
sessionToken | String | user token |
Example
{
"event": "gei:apps:uninstalled:app",
"appKey": "work-hour",
"tenant": "osc",
"versionKey": "1.0",
"environmentKey": "production",
"sessionToken": "r:eeii23498saowewerazf"
}