Collaboard App

Prev Next

The Collaboard app seamlessly delivers powerful visual collaboration right inside your Rocket.Chat workspace. It enables teams to brainstorm, plan, and manage projects using Collaboard’s online whiteboard, all without ever leaving Rocket.Chat. By streamlining communication and idea generation, it helps transform conversations into concrete actions. This guide will walk you through installing the Collaboard app in Rocket.Chat and linking it to your Collaboard account.

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, review the required permissions, and accept them to complete the installation.

Create a Collaboard API key

Before you proceed, confirm that you have a Collaboard account with access to API keys. The Collaboard app requires an API key to be associated with Rocket.Chat to function properly.

To create a Collaboard API key,

  • 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.

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*

    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

    • CH→ch.collaboard.app

    • DE →de.collaboard.app

    • On-premise → Use your custom domain.

    API endpoint*

    By default, it is api.collaboard.app. This is the API base URL for your selected environment. Update the Client host API endpoint if you're using a different region or a self-hosted instance:

    • WEB→api.collaboard.app

    • CH→ch-api.collaboard.app

    • DE→de.collaboard.app/server

    • On-premise → Use the API endpoint configured during the Collaboard installation

    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 shared project link from your workspace:

    • No access: No user can create a collaboard project in the room.

    • Can view: The project is read-only for registered Collaboard users.

    • Can edit: 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

    Set the project link validity in minutes.

    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 app to create and share whiteboards.