Voznest Forge

Workspace

WorkspaceProjects

Development

DocsAPI ReferenceSDKsEmbed StudioChangelog
  1. Forge
  2. /Docs

Start here

Getting StartedQuickstartPlatform ConceptsEnvironments

Build

ProjectsIdentityAgentsGatewayCapabilitiesPermissions ReferenceInstallationsLive activity

Commands & interactions

CommandsContext-menu CommandsInteractionsComponentsModals (Forms)Activities (Embedded Apps)

Acting in hubs

MessagesEmbedsEmbeds v2 (Blocks)Embeds v3Incoming WebhooksHub Management APIEvent StreamDelivery

Sign in with Voznest

AccessOpenID Connect

API

APIAuthenticationErrorsRate LimitsSecurity

Publish & operate

App Market & ListingTemplates & SandboxObservability & Team Tools

Tools

SDKsExamplesFAQ & TroubleshootingReference

Build

Installations

How a project gets into a hub, what the install screen shows, and what happens on uninstall.

Installing puts the project's agent into a hub with a managed role holding the granted capabilities. Only people with Manage Hub can install, and they can grant fewer capabilities than requested.

Ways to install

HowEnvironmentNotes
App Market → Add to HubProductionOnly for public projects (Project Settings → Listing).
Install linkProductionPrivate projects too. GET /applications/:id/install returns what the screen shows.
OAuth with agent.installProductionFrom your website: the person picks the hub on the consent screen.
Agents → Install in a test hubDevelopment / StagingInto hubs you manage. See Environments.
Sandbox hubDevelopmentOne click from Templates & Sandbox.

After installing

  • The agent receives SERVER_CREATE and starts getting the hub's events; subscriptions receive installation.created.
  • Global commands appear in the hub immediately. Hub-specific commands can now be published for it.
  • The installation is recorded in the hub's audit log and in your project's Installations list.

Uninstalling

A hub manager can remove the app at any time (Hub Settings → Integrations). The agent leaves, its managed role is deleted, hub commands for that hub are removed and you receive installation.removed.

GET/servers/:id/integrationsApps installed in a hub (for hub managers and agents)
PreviousPermissions ReferenceNext Commands