Deep Linking

Prev Next

Rocket.Chat supports deep linking for mobile and desktop clients, enabling links that open specific content or trigger actions within the application. This is implemented through registered URLs handled directly by the clients.

Two prefixes are available for deep links:

  1. Go links: Links that begin with https://go.rocket.chat. These are universal and supported across web, mobile, and desktop clients.

  2. Custom protocol: Links that use the rocketchat:// prefix and are supported by mobile and desktop clients.

https://go.rocket.chat/ and rocketchat:// are interchangeable in supported environments.

Adding server and authentication links

  • Add a server: Deep links can add a server to a client using a universal link.

  • Authentication links: Links beginning with https://go.rocket.chat/auth can include the server host, user token, and user ID to authenticate a user automatically.

Examples:

Link directly to a server

https://go.rocket.chat/auth?host=open.rocket.chat

Link to a server and authenticate

https://go.rocket.chat/auth?host=foo.bar.com&token=123abc&userId=1234abcd

Room links

Deep links can open a specific room using the https://go.rocket.chat/room prefix. These links require the server host and the room ID (rid). An optional web path can also be included.

Example:

https://go.rocket.chat/room?host=open.rocket.chat&rid=GENERAL&path=channel/general

Invite links

Invite links use the https://go.rocket.chat/invite prefix and require the server host and a path containing the invitation token.

Example:

https://go.rocket.chat/invite?host=open.rocket.chat&path=invite/xyzxyZ

Conference call links

Conference calls can be initiated using the https://go.rocket.chat/conference prefix. These links require the server host, the conference path (conferenceId), the call URL, and the provider name.

Example:

https://go.rocket.chat/conference?host=open.rocket.chat&path=conference/12345?callUrl=https://providerHost/someinfoOrPath&callProvider=...