Deprecated and phasing out features

This document outlines features that are no longer supported in Rocket.Chat or are scheduled for removal in future updates (deprecated). It also serves as an early notice for workspace managers to adjust and optimize their workspaces accordingly. Please note that this information is subject to change with future releases and may not include every deprecated feature.

Breaking changes in upcoming versions

Rocket.Chat Server v8.0.0

Removal of deprecated features

Several outdated features will be removed in v8.0.0 to simplify the codebase, improve performance, and mitigate security risks.

  • API endpoint replacements and removals: The following deprecated API methods and endpoints will be removed, with some being replaced by improved alternatives.

Type

Name

Replacement

Deprecated since

Planned to be removed in

Method

insertOrUpdateUser

Users upsert no longer allowed; method to be completely removed

6.7.0

8.0.0

Endpoint

/users.createToken

The endpoint will be removed.

6.8.0

8.0.0

Method

muteUserInRoom

Replaced by the /rooms.muteUser endpoint.

6.8.0

8.0.0

Method

unmuteUserInRoom

Replaced by the /rooms.unmuteUser endpoint.

6.8.0

8.0.0

Method

createToken

This method will be removed.

6.8.0

8.0.0

  • API parameters replacements and removals: The following deprecated API parameters will be removed.

Type

Name

Parameter affected

Description

Deprecated since

Planned to be removed in

Endpoint

All endpoints using this parameter

fields

Removed to avoid malicious queries.

5.0.0

8.0.0

Endpoint

All endpoints using this parameter

query

Removed to avoid malicious queries.

5.0.0

8.0.0


Rocket.Chat Server v7.0.0

Platform and database enhancements

  • We have upgraded the platform to Meteor 3.0 and Node.js 20, bringing in the latest security improvements, bug fixes, and performance optimizations. However, this update may require environmental adjustments, especially if your application relies on older Node.js features or Meteor packages. Developers should review their environment and ensure all dependencies are compatible with these new versions.

  • With MongoDB 4.4 reaching end-of-life, we have discontinued its support in favor of MongoDB 7.0. The new version offers enhanced performance, security improvements, and new features like support for multi-document ACID transactions. MongoDB 5.0 is now deprecated. If you're still using MongoDB 4.4 or 5.0, an upgrade is necessary to maintain compatibility with our platform. It’s important to test your database migration thoroughly to avoid potential data or performance issues.

Security and compliance updates:

  • Removal of Compatible Sandbox (vm2) for Integration Scripts: We've fully removed the Compatible Sandbox option for integration scripts. Previously, Rocket.Chat allowed users to choose between two sandboxing libraries for script execution: vm2 (Compatible Sandbox) and isolated-vm (Secure Sandbox). Due to critical security vulnerabilities and lack of ongoing support for vm2, it is no longer available as of version 7.0. All scripts will now run exclusively in the Secure Sandbox environment. This change may impact integration scripts that relied on vm2's behavior. Review your integration scripts to ensure they are compatible with the secure sandbox.

  • Enhanced security for app installations: Starting with this release, the ability to upload private apps is now restricted to our premium plans (Starter, Pro, and Enterprise). This change helps us 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 the value and security of our platform.

  • The ability to install apps from a URL will be removed.

  • Unused settings such as UI_Click_Direct_Message and the view-history permission have been removed to comply with security best practices and reduce clutter.

Permissions and endpoint enhancements:

  • New permissions for room management in teams: New permissions (create-team-channel and create-team-group) have been added to enhance control over room creation within teams. These permissions integrate closely with team management functions and ensure proper visibility and control.

  • Improved error messaging for login attempts: The login process will no longer suggest which credential is incorrect, returning a generic "Unauthorized" error instead to enhance security.

  • Disabled query and fields API parameters: The query and fields parameters have been disabled and can only be enabled by setting the ALLOW_UNSAFE_QUERY_AND_FIELDS_API_PARAMS: true environment variable. Enabling them may expose your workspace to security breaches, for which Rocket.Chat is not responsible.

Omnichannel and integration adjustments:

  • Fixes for stuck omnichannel rooms: A migration will correct the statuses of inquiries linked to rooms that are closed but still listed as active due to systemic issues.

  • Removed dependencies: The dependency on the meteor/check package has been removed from all v1 endpoints to avoid errors and enhance performance.

Air-gapped workspace restrictions for commercial licensing

Starting with this release, Rocket.Chat Community Edition will no longer support air-gapped environments (environments without internet access). To ensure compliance with licensing agreements, only users on premium plans—including the free Starter plan—can run Rocket.Chat in these air-gapped setups. Our standard builds include commercial code, so restricting air-gapped environments to premium users helps maintain security and proper licensing compliance. Community users who need Rocket.Chat without commercial restrictions can use the fossify script. This tool removes all premium code, leaving a fully open-source version with no limitations (e.g., no user or MAC limits). While this doesn’t include our commercial air-gapped setup, it allows users to build their own offline solutions and customize them on top of our open-source code as they wish. For details, check out the fossify script.

Removal of deprecated features

Several outdated features have been removed to streamline the codebase and improve overall system performance:

  • HipChat importer removed: Due to the discontinuation of HipChat, the HipChat importer is no longer supported. If you’re still migrating from HipChat, consider using alternative import methods or manually migrating your data.

  • Unused oauth settings removed: We’ve pruned unused and outdated OAuth settings to simplify the configuration process. The button text color and button color settings will be removed. If your system still relies on these deprecated settings, update your configurations to avoid potential authentication issues.

  • API endpoint replacements and removals: The following older API methods and endpoints have been deprecated in favor of newer, more efficient ones.

Type

Name

Replacement

Deprecated since

Removed in version

Method

eraseRoom

Replaced by rooms.delete endpoint

5.4.0

7.0.0

Method

roomNameExists

Replaced by rooms.nameExists endpoint

5.1.0

7.0.0

Method

deleteMessage

Replaced by chat.delete endpoint

6.2.0

7.0.0

Method

checkUsernameAvailability

Replaced by users.checkUsernameAvailability endpoint

5.4.0

7.0.0

Method

listEmojiCustom

Replaced by emoji-custom.list endpoint

5.4.3

7.0.0

Method

refreshClients

Now triggered by assets.setAsset and assets.unsetAsset

5.4.0

7.0.0

Method

removeWebdavAccount

Replaced by webdav.removeWebdavAccount endpoint

5.1.0

7.0.0

Method

Mailer:unsubscribe

Replaced by mailer.unsubscribe endpoint

5.4.0

7.0.0

Method

Mailer.sendMail

Replaced by mailer endpoint

5.4.0

7.0.0

Method

reportMessage

Replaced by chat.reportMessage endpoint

6.2.0

7.0.0

Method

getPasswordPolicy

Replaced by pw.getPolicy endpoint

5.1.0

7.0.0

Method

livechat:addAgent

Replaced by livechat/users/agent (POST) endpoint

5.2.0

7.0.0

Method

livechat:addManager

Replaced by livechat/users/manager (POST) endpoint

5.2.0

7.0.0

Method

livechat:getCustomFields

Replaced by livechat/custom-fields endpoint

5.2.0

7.0.0

Method

livechat:getNextAgent

Replaced by livechat/agent.next/:token endpoint

5.2.0

7.0.0

Method

livechat:loadHistory

Replaced by livechat/messages.history/:rid endpoint

5.2.0

7.0.0

Method

livechat:loginByToken

Replaced by livechat/visitor/:token endpoint

5.2.0

7.0.0

Method

livechat:pageVisited

Replaced by livechat/page.visited endpoint

5.2.0

7.0.0

Method

livechat:registerGuest

Replaced by livechat/visitor endpoint

5.2.0

7.0.0

Method

livechat:removeAgent

Replaced by livechat/users/agent/:_id endpoint

5.2.0

7.0.0

Method

livechat:removeDepartment

Replaced by livechat/department/:_id endpoint

5.2.0

7.0.0

Method

livechat:removeManager

Replaced by livechat/users/manager/:_id endpoint

5.2.0

7.0.0

Method

livechat:saveDepartmentAgents

Replaced by livechat/department/:_id/agents endpoint

5.2.0

7.0.0

Method

livechat:saveSurveyFeedback

Replaced by livechat/room.survey endpoint

5.2.0

7.0.0

Method

livechat:searchAgent

Replaced by livechat/users/agent/:_id endpoint

5.2.0

7.0.0

Method

livechat:sendOfflineMessage

Replaced by livechat/offline.message endpoint

5.2.0

7.0.0

Method

livechat:setCustomField

Replaced by livechat/visitor endpoint

5.2.0

7.0.0

Method

livechat:setDepartmentForVisitor

Replaced by livechat/visitor endpoint

5.2.0

7.0.0

Method

livechat:discardTranscript

Replaced by livechat/transcript/:rid (DELETE) endpoint

6.4.0

7.0.0

Method

livechat:getAgentOverviewData

Replaced by livechat/analytics/agent-overview endpoint

6.4.0

7.0.0

Method

livechat:getAnalyticsOverviewData

Replaced by livechat/analytics/overview endpoint

6.4.0

7.0.0

Method

livechat:removeTrigger

Replaced by livechat/triggers/:_id (DELETE) endpoint

6.5.0

7.0.0

Method

livechat:requestTranscript

Replaced by livechat/transcript/:rid endpoint

6.4.0

7.0.0

Method

livechat:saveAppearance

Replaced by livechat/appearance endpoint

6.4.0

7.0.0

Method

livechat:saveInfo

Replaced by livechat/room.saveInfo endpoint

5.3.0

7.0.0

Method

livechat:saveIntegration

Replaced by omnichannel/integrations (POST) endpoint

6.2.0

7.0.0

Method

livechat:saveTrigger

Replaced by livechat/triggers endpoint

6.4.0

7.0.0

Method

livechat:webhookTest

Replaced by livechat/webhook.test endpoint

5.4.0

7.0.0

Method

livechat:getAgentData

Replaced by livechat/agent.info/:rid/:token endpoint

6.4.0

7.0.0

Method

addOauthApp

Replaced by oauth-apps.create endpoint

6.2.0

7.0.0

Endpoint

pw.getPolicyReset

Replaced by pw.getPolicy endpoint

6.3.0

7.0.0

Endpoint

licenses.get

Replaced by licenses.info endpoint

6.5.0

7.0.0

Endpoint

licenses.isEnterprise

Replaced by licenses.info endpoint

6.5.0

7.0.0

Endpoint

channels.images

Replaced by rooms.images endpoint

6.8.0

7.0.0

Endpoint

livechat/room.transfer

Replaced by licenses/room.forward endpoint

5.2.0

7.0.0

Endpoint

livechat/inquiries.queued

Replaced by livechat/inquiries.queuedForUser endpoint

5.4.1

7.0.0

Endpoint

livechat/room.visitor

The endpoint has been removed.

5.2.0

7.0.0

  • The following parameters have been removed and replaced.

Type

Name

Parameter affected

Description

Deprecated since

Removed in version

Method

authorization:removeUserFromRole

role

This parameter will no longer accept roleName as a fallback. Use only roleId instead.

4.6.0

7.0.0

Method

authorization:deleteRole

role

This parameter will no longer accept roleName as a fallback. Use only roleId instead.

4.6.0

7.0.0

Method

authorization:addUserToRole

role

This parameter will no longer accept roleName as a fallback. Use only roleId instead.

4.6.0

7.0.0

Method

apps (POST)

downloadOnly

This parameter will no longer be accepted.

6.6.0

7.0.0

Endpoint

roles.getUsersInRole

role

The role parameter will still be used, but its value must now always be the role ID. Querying with the role name as value is deprecated.

4.6.0

7.0.0

Endpoint

oauth-apps.get

appId

This parameter will no longer be accepted (use clientId or _id instead).

6.0.0

7.0.0

Endpoint

roles.addUserToRole

roleName

This parameter will no longer be accepted. Use roleId instead.

4.6.0

7.0.0

Endpoint

roles.removeUserFromRole

roleName

This parameter will no longer be accepted. Use roleId instead.

4.6.0

7.0.0

This update is critical for maintaining the operational integrity, security, and efficiency of Rocket.Chat workspaces. Workspace managers should review these changes carefully and begin preparations for a smooth transition to version 7.0.0.

For more detailed information, check out our GitHub release page.