ForgeInvocationContext
Defined in: packages/core/src/adapters/ForgeInvocationPayload.ts:28
The context object within a Forge Remote invocation payload. Contains information about the user and site that triggered the invocation.
Properties
Section titled “Properties”accountId?
Section titled “accountId?”
optionalaccountId?:string
Defined in: packages/core/src/adapters/ForgeInvocationPayload.ts:30
The Atlassian account ID of the user who triggered the invocation, if any
appVersion?
Section titled “appVersion?”
optionalappVersion?:string
Defined in: packages/core/src/adapters/ForgeInvocationPayload.ts:40
The app version
cloudId?
Section titled “cloudId?”
optionalcloudId?:string
Defined in: packages/core/src/adapters/ForgeInvocationPayload.ts:32
The Atlassian cloud ID of the site
environmentId?
Section titled “environmentId?”
optionalenvironmentId?:string
Defined in: packages/core/src/adapters/ForgeInvocationPayload.ts:38
The environment ID
environmentType?
Section titled “environmentType?”
optionalenvironmentType?:"DEVELOPMENT"|"STAGING"|"PRODUCTION"
Defined in: packages/core/src/adapters/ForgeInvocationPayload.ts:36
The environment type (development, staging, production)
moduleKey?
Section titled “moduleKey?”
optionalmoduleKey?:string
Defined in: packages/core/src/adapters/ForgeInvocationPayload.ts:42
The module key that was invoked
siteUrl?
Section titled “siteUrl?”
optionalsiteUrl?:string
Defined in: packages/core/src/adapters/ForgeInvocationPayload.ts:34
The site URL (e.g. https://your-site.atlassian.net)