Chat Module

The chat module allows the creation of chat dialogs in the right side panel of the Crowdin or Crowdin Enterprise UI. The panel is opened and closed with a button in the header.

How It Works

Each app with a chat module gets its own button in the header, with the app’s logo. When more than two chat modules are installed (Crowdin Copilot’s included), all apps except Crowdin Copilot share one button that opens a menu. The Crowdin Copilot button always stays separate and comes last.

Users can resize the panel by dragging its left edge. The minimum width is 420 pixels, so design your app’s page to work at that width. The chosen width is remembered in the browser.

Access

You can grant access to this module to one of the following user categories:

For Crowdin:

• Only me (i.e., project owner)
• All project members
• Selected users

For Crowdin Enterprise:

• Only organization admins
• All users in the organization projects
• Selected users

Structure

manifest.json

{
  "modules": {
    "chat": [
      {
        "key": "your-module-key",
        "name": "Module name",
        "description": "Module description",
        "url": "/chat-page"
      }
    ]
  }
}

Properties

key	Type: string Required: yes Description: Module identifier within the Crowdin app.
name	Type: string Description: The human-readable name of the module. Defaults to the app name if not specified.
description	Type: string Description: The human-readable description of what the module does. The description will be visible in the Crowdin or Crowdin Enterprise UI.
url	Type: string Required: yes (self-hosted apps only) Description: The relative URL to the content page of the module that will be integrated into the Crowdin or Crowdin Enterprise UI.
environments	Type: string Allowed values: crowdin, crowdin-enterprise Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.