The Collaboard app delivers powerful visual collaboration right inside your Rocket.Chat workspace. It enables teams to brainstorm, plan, and manage projects using Collaboard’s online whiteboard, without leaving Rocket.Chat. By streamlining idea generation and communication, it helps transform conversations into concrete actions. This guide will walk you through setting up the Collaboard app in Rocket.Chat and linking it to your Collaboard account.
Prerequisite
A Collaboard Enterprise account
Create a Collaboard API key
To integrate the Collaboard app with Rocket.Chat, you'll need a Collaboard API key. Be sure you have a Collaboard account and an available API key before you start the integration process. If not, you can create a Collaboard API key with these steps:
Navigate to your Collaboard profile and go to API keys.
Click the Create API key button. Add your preferred Title and Duration in minutes for the API key.
Click Create API key and the API key is generated for you.
Copy the API key to your clipboard. You'll need it for configuring the app in your workspace.
API keys are only available on the Collaboard Enterprise plan.
Install the Collaboard app
To install the Collaboard app,
Go to Administration > Apps > Marketplace > Explore.
Search for Collaboard, then click on the app from the results.
Click Install and agree to the Terms & Policy. Review the required permissions and click Agree to complete the installation.
Configure the Collaboard app
To configure the Collaboard app after installing it,
On the Collaboard App Info screen, navigate to Settings and update the following fields:
Field
Description
Application hostname*
The client host. By default, it is
web.collaboard.app. Update this if you're using a different region or a self-hosted instance:WEB→web.collaboard.app
Switzerland→ch.collaboard.app
Germany →de.collaboard.app
On-premise → Use your custom domain.
Do not include https://.
API endpoint*
The client host API endpoint. By default, it is
api.collaboard.app. This is the API base URL for your selected environment. Update this you're using a different region or a self-hosted instance:WEB→
api.collaboard.appSwitzerland→
ch.api.collaboard.appGermany→
de.api.collaboard.appOn-premise → Use the API endpoint configured during the Collaboard installation
Do not include https://.
API key*
Paste the API key you created in your Collaboard account. This key connects your Rocket.Chat workspace to your Collaboard projects.
Registered users
Set access permissions for registered Collaboard users when they open a Collaboard project link from your workspace:
No access: Registered Collaboard users can not create or acesss a project from your workspace
Can view: The project is read-only for registered Collaboard users.
Can edit: Registered Collaboard users can view and edit the project.
Guest users
Set the access permissions for guest Collaboard users when they open a Collaboard project link from your workspace:
No access: Guest users will be required to sign in to view the project.
Can view: The project is read-only for guest Collaboard users.
Can edit: Guest users can view and edit the project.
Validity
Define the project link validity period (in minutes). After this time, the access link to the project from Rocket.Chat will expire.
Require user identification
If enabled, guest users must enter their name and email before accessing the project. This adds a layer of accountability.
Click Save Changes.
You're now ready to start using Collaboard from within your Rocket.Chat workspace. The next section covers how to use the Collaboard app to create and share whiteboards from Rocket.Chat.