Rocket.Chat allows you to develop and deploy private apps tailored to your specific workspace needs. Unlike public apps, these are manually installed and are only functional within the workspaces where they are uploaded. You can also share your app package privately with other workspace owners for use in their respective environments.
To start developing a Rocket.Chat app, refer to the Apps-Engine guide.
With Apps-Engine, you can create apps to:
Display interactive and dynamic content on their interface, like a modal or the room’s contextual bar.
Create buttons in the UI for users to interact with native content.
Create slash commands for users to trigger more generic interactions.
Register endpoints to receive data from other applications and services.
Work on both desktop and mobile clients.
Send messages to users, create and manage public channels, groups, discussions, and threads.
Upload and install a private app
To install a private app,
Package the app in a
.zipformat.Click Marketplace
> Explore > Private Apps in the workspace.Click Upload Private App.
Click Browse Files and select your
.zippackage.Agree to the required permissions to finalize the installation. Once complete, your app will be installed and ready to use.
Starting with Rocket.Chat Version 7.0, the ability to upload private apps is restricted to our premium plans (Starter, Pro, and Enterprise). This change is designed to maintain the integrity of Rocket.Chat's customization options while safeguarding the exclusive features of our paid plans. By limiting private app uploads, we ensure that only licensed users can fully tailor their experience, protecting both the value and security of our platform.
Enable or disable a private app
Private apps are enabled automatically after installation. You can disable an app temporarily without uninstalling it. There are two ways to disable or enable an app:
Option 1: From the marketplace
Click Marketplace
> Explore > Private Apps and search for the app.Select the kebab (:) menu next to the app.
Click Enable or Disable.
Option 2: From the App info page
Click Marketplace
> Explore > Private Apps and search for the app.Click the app to open the app’s App Info page.
Select the kebab (:) menu under the app name and description.
Click Enable or Disable.
View app logs
To inspect the logs from the app,
Click Marketplace
> Explore > Private Apps and search for the app.Click the app to open the app’s App Info page.
Select the kebab (:) menu under the app name and description.
Click View Logs.
Alternatively, you can navigate to the Logs tab from the App Info page.
Private app limit for Community workspaces from 7.0
Starting with Rocket.Chat version 7.0, only workspaces on premium plans can install and use private apps. For community users, the following changes will apply:
Exemption to existing private apps:
If you had private apps installed and enabled before upgrading to version 7.0, you will still be able to use them. Rocket.Chat will exempt these apps from the private app limit policy.Re-enabling disabled apps:
If you disabled an app before updating to version 7.0, you can re-enable and use it after the update.Uninstalling private apps:
If you uninstall a private app after upgrading to version 7.0, you will not be able to re-upload or reinstall it.Downgrading from Premium to Community after a trial period or paid subscription:
You will be able to continue using the apps you have after downgrading your workspace.