Skip to main content

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

NameTypeDescription
eventStringgei:apps:installed:app
appKeyStringapp key
tenantStringtenant key
versionKeyStringversion
environmentKeyStringenvironment key
sessionTokenStringuser 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

NameTypeDescription
eventStringgei:apps:upgraded:app
appKeyStringapp key
tenantStringtenant key
versionKeyStringversion
environmentKeyStringenvironment key
sessionTokenStringuser 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

NameTypeDescription
eventStringgei:apps:uninstalled:app
appKeyStringapp key
tenantStringtenant key
versionKeyStringversion
environmentKeyStringenvironment key
sessionTokenStringuser token

Example

{
"event": "gei:apps:uninstalled:app",
"appKey": "work-hour",
"tenant": "osc",
"versionKey": "1.0",
"environmentKey": "production",
"sessionToken": "r:eeii23498saowewerazf"
}