Integrations Module

The module allows creating and inserting a new integration within the Crowdin project. You can find it in the Integrations section of project page. It is available to project members with manager permissions (or higher).

Structure

{
  "project-integrations": [
    {
      "key": "your-module-key",
      "name": "Module name",
      "description": "Module description",
      "logo": "/logo.png",
      "url": "/integration-page"
    }
  ]
}

Properties

key

Type: string

Required: yes

Description: Module identifier within the Crowdin app.

name

Type: string

Required: yes

Description: The human-readable name of the module.

description

Type: string

Description: The human-readable description of what the module does.
The description will be visible in the Crowdin Enterprise UI.

logo

Type: string

Required: yes

Description: The relative URL to the integration's logo that will be displayed in the Crowdin Enterprise UI.
The recommended resolution is 48x48 pixels.

url

Type: string

Required: yes

Description: The relative URL to the content page of the module that will be integrated into the 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.

Was this article helpful?