Introduction to Managing Apps

Rocket.Chat apps extend a workspace with integrations and features, installed from the marketplace or uploaded as private apps. The Manage Apps endpoints let administrators browse the marketplace, install and uninstall apps, and read app logs programmatically; the API counterpart of the Marketplace admin area.

The app object

App endpoints return app objects. A trimmed example from List Installed Apps:

{
  "apps": [
    {
      "id": "346b465f-3087-4596-ad7f-b0885540451c",
      "name": "Google Meet",
      "nameSlug": "google-meet",
      "version": "1.0.4",
      "requiredApiVersion": "^1.33.0",
      "description": "Google Meet Conference Calls Provider",
      "author": {
        "name": "Rocket.Chat Technologies Corp.",
        "homepage": "https://github.com/RocketChat/Rocket.Chat"
      }
    }
  ],
  "success": true
}

Fields you use most often:

• id: The app ID. Pass it in the path when fetching details, uninstalling, or reading an app's logs.

• version and requiredApiVersion: The installed app version and the Apps-Engine API range it needs.

• nameSlug: The URL-friendly identifier used in the marketplace.

Common workflows

Install and manage an app

1. List the marketplace apps or browse app categories to find an app, or install a private app from its package.

2. List the installed apps and fetch an app's details by its id.

3. Uninstall the app when it is no longer needed.

Troubleshoot an app

1. Get the app's logs, or all apps' logs, to see what the app executed and any errors.

2. Get the apps count to check installed and enabled totals against your plan's limits.

3. If a user needs an app you have not installed, they can generate an app request form for admins to review.

Conventions

• These endpoints live under /api/apps rather than /api/v1 . Note the different base path.

• Managing apps requires the manage-apps admin permission. Each endpoint page lists its requirements.

• Apps run on the Apps-Engine: an app only installs if the workspace's engine satisfies the app's requiredApiVersion. Private app uploads can be restricted by the workspace's plan and settings.

• For the admin UI equivalent, see the Rocket.Chat Marketplace guide.