Modules allow apps to extend the Crowdin Enterprise user interface, create integrations with external services, etc.
More Crowdin Apps modules are coming soon.
The integrations module allows creating and inserting a new integration within the Crowdin Enterprise project. You can find it in the Integrations > Custom. This module is available to project members with manager permissions (or higher).
Integration module structure:
{
"integrations": [
{
"key": "your-module-key",
"name": "Module name",
"description": "Module description",
"logo": "/logo.png",
"url": "/integration-page"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |
description | Type: Description: The human-readable description of what the module does. |
logo | Type: Required: yes Description: The relative URL to the integration's logo that will be displayed in the Crowdin Enterprise UI. |
url | Type: Required: yes Description: The relative URL to the content page of the module that will be integrated into the Crowdin Enterprise UI. |
environments | Type: Allowed values: Description: Set of environments where a module could be installed. |
The crowdsource-panels module allows creating additional tabs on the crowdsourcing public page of the project. To work with this module, make sure that your project meets the following requirements:
This module is available to all authorized users.
Crowdsource-panel module structure:
{
"crowdsource-panels": [
{
"key": "your-module-key",
"name": "Module name",
"url": "/crowdsource-page"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |
url | Type: Required: yes Description: The relative URL to the content page of the module that will be integrated into the Crowdin Enterprise UI. |
The editor-panels module allows creating additional tabs in the Editor. When using this module in your Crowdin app, you can choose the Editor mode where you’d like the additional tabs to be displayed. Editor-panels module is available only to the project members that have access to the Editor.
Editor-panel module structure:
{
"editor-panels": [
{
"key": "your-module-key",
"position": "right",
"name": "Module name",
"modes": ["translate", "proofread"],
"url": "/editor-page"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
position | Type: Required: yes Allowed values: Description: The position where the module will be placed. |
name | Type: Required: yes Description: The human-readable name of the module. |
modes | Type: Required: yes Allowed values: Description: The Editor's mode list where the module will be available. |
url | Type: Required: yes Description: The relative URL to the content page of the module that will be integrated into the Crowdin Enterprise UI. |
environments | Type: Allowed values: Description: Set of environments where a module could be installed. |
The organization menu module allows creating a new section in the left panel of the Workspace home page. This module is available only to organization admins.
Organization menu module structure:
{
"organization-menu": [
{
"key": "your-module-key",
"name": "Module name",
"url": "/organization-page",
"icon": "/images/icon.png"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |
url | Type: Required: yes Description: The relative URL to the content page of the module that will be integrated into the Crowdin Enterprise UI. |
icon | Type: Required: yes Description: The relative URL to the new section's icon that will be displayed in the Crowdin Enterprise UI. |
The project menu module allows creating a new section in the left panel of the project home page. This module is available to selected project roles.
Project menu module structure:
{
"project-menu": [
{
"key": "your-module-key",
"name": "Module name",
"url": "/project-page"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |
url | Type: Required: yes Description: The relative URL to the content page of the module that will be integrated into the Crowdin Enterprise UI. |
environments | Type: Allowed values: Description: Set of environments where a module could be installed. |
This module helps you connect machine translation engines that are not supported by Crowdin yet. Once you create this kind of app, you’ll be able to pre-translate your content with the connected MT or enable translation suggestions made by it to be shown in the Editor for translators.
Custom MT module structure:
{
"custom-mt": [
{
"key": "custom-mt",
"name": "Custom MT",
"url": "/translate"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |
url | Type: Required: yes Description: The relative URL to the content page of the module that will be integrated with Crowdin. |
environments | Type: Allowed values: Description: Set of environments where a module could be installed. |
The tools module allows creating and inserting a new tool page within the Crowdin Enterprise project. You can find it in the Tools section. This module is available to project members with manager permissions (or higher).
Tools module structure:
{
"tools": [
{
"key": "your-module-key",
"name": "Module name",
"description": "Module description",
"logo": "/logo.png",
"url": "/tools-page"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |
description | Type: Description: The human-readable description of what the module does. |
logo | Type: Required: yes Description: The relative URL to the tool's logo that will be displayed in the Crowdin Enterprise UI. |
url | Type: Required: yes Description: The relative URL to the content page of the module that will be integrated into the Crowdin Enterprise UI. |
environments | Type: Allowed values: Description: Set of environments where a module could be installed. |
The reports module allows creating and inserting a new report within the Crowdin Enterprise project. You can find it in the Translations > Reports. This module is available to project members with manager permissions (or higher).
Reports module structure:
{
"reports": [
{
"key": "your-module-key",
"name": "Module name",
"description": "Module description",
"logo": "/logo.png",
"url": "/reports-page"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |
description | Type: Description: The human-readable description of what the module does. |
logo | Type: Required: yes Description: The relative URL to the tool's logo that will be displayed in the Crowdin Enterprise UI. |
url | Type: Required: yes Description: The relative URL to the content page of the module that will be integrated into the Crowdin Enterprise UI. |
environments | Type: Allowed values: Description: Set of environments where a module could be installed. |
Use this module to add support of new custom file formats. It’s implemented by delegating a source file parsing to an app with a custom file format module. When translations are completed, Crowdin Enterprise passes a source file and a string array with translations to the Custom file format app for translation files generation. This module is available to project members with manager permissions (or higher).
Custom File Format module structure:
{
"custom-file-format": [
{
"key": "your-module-key-type-xyz",
"type": "type-xyz",
"url": "/process",
"multilingual": true,
"signaturePatterns": {
"fileName": "^.+\\.xyz$",
"fileContent": "<properties>\\s*<property\\s+name=.*value=.*/>"
}
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
type | Type: Required: yes Description: The custom file format identifier. Can be used in API to force the processing of the files by the Custom file format app. If the |
url | Type: Required: yes Description: The relative URL triggered on file import, update, translation upload, and export. |
multilingual | Type: Required: no Allowed values: Description: This parameter is used to combine the content of multiple languages into one request when uploading and downloading translations in your Crowdin Enterprise project. |
signaturePatterns | Type: Description: Contains Note: fileContent regular expression checks only the first 64 KB of the file content. |
On the initial file import, the system detects custom file format using the signaturePatterns or type parameters and makes an HTTP request to the app’s URL ($baseUrl . $url) for further processing. Then app processes the file in a custom format and responds to the system. The requests and responses to and from the custom file format apps have two-minute timeouts. The maximum request and response payload size is limited to 5 MB.
Request payload example:
// max request payload - 5 MB
// wait timeout - 2 minutes
{
"jobType": "parse-file | build-file",
"organization": {
"id": 1,
"domain": "{domain}",
"baseUrl": "https://{domain}.crowdin.com",
"apiBaseUrl": "https://{domain}.api.crowdin.com"
},
"project": {
"id": 1,
"identifier": "your-project-identifier",
"name": "Your Project Name"
},
"file": {
"id": 1,
"name": "file.xml",
"content": "VGhpcyBpcyBmaWxlIGNvbnRlbnQ=", // base64 encoded source file content
"contentUrl": "https://crowdin-tmp.downloads.crowdin.com/1/file.xml?aws-signature=..." // source file public URL
},
"sourceLanguage": {
"id": "es",
"name": "Spanish",
"editorCode": "es",
"twoLettersCode": "es",
"threeLettersCode": "spa",
"locale": "es-ES",
"androidCode": "es-rES",
"osxCode": "es.lproj",
"osxLocale": "es",
"pluralCategoryNames": ["one"],
"pluralRules": "(n != 1)"
},
"targetLanguages": [{
// same structure as for sourceLanguage, empty when uploading a new source file, one element for import_translations & export, can be more for miltilingual files
}],
"strings": [...], // for the build-file jobs, array of segments
"stringsUrl": "https://tmp.downloads.crowdin.com/strings.ndjson", // for the build-file jobs, file with segments, in new-line delimited json format
}
Properties:
jobType | Type: Possible values: Description: Specifies the action that should be executed by the app. |
file.content, file.contentUrl | Type: Description: Parameters used to pass the base64 encoded source file content ( |
strings, stringsUrl | Type(strings): Type(stringsUrl): Description: Parameters used for translations download (for |
Response payload example:
// max response payload - 5 MB
// wait timeout - 2 minutes
{
"data": {
"strings": [...], // segments array
"stringsUrl": "https://app.example.com/jKe8ujs7a-segments.ndjson", // new-line delimited json file with parsed strings
"preview": "VGhpbmdzIGFyZSBvbmx5IGltcG9zc2libGUgdW50aWwgdGhleSdyZSBub3Qu", // optional, base64 encoded content of preview html file, not supported if there are plural strings
"previewUrl": "https://app.example.com/LN3km2K6M-preview.html", // optional, URL of preview html file, not supported if there are plural strings
},
"error": {
"message": "Your error message"
}
}
Properties:
data.strings, data.stringsUrl | Type(data.strings): Type(data.stringsUrl): Description: Parameters used to pass the parsed strings content. |
preview, previewUrl | Type(preview): Type(previewUrl): Description: Parameters used to pass the optional HTML preview of the parsed strings content, which can be generated by the app. The generated HTML preview will be displayed in the Editor. See the HTML Preview file example. Note: HTML preview won't be displayed in the Crowdin Editor if the app passes strings with plurals. |
error.message | Type: Description: An error message that can be passed from the app to Crowdin Enterprise and will be visible to a user in UI. |
Response payload example:
// max response payload - 5 MB
// wait timeout - 2 minutes
{
"data": {
"content": "TWF5IHRoZSBGb3JjZSBiZSB3aXRoIHlvdS4=", // base64 encoded translation file content
"contentUrl": "https://app.example.com/p5uLEpq8p-result.xml", // translation file public URL
},
"error": {
"message": "Your error message"
}
}
Properties:
data.content, data.contentUrl | Type(data.content): Type(data.contentUrl): Description: Parameters used to pass the base64 encoded translation file content ( |
error.message | Type: Description: An error message that can be passed from the app to Crowdin Enterprise and will be visible to a user in UI. |
Below you can see an example of the strings structure expected from the app for parse-file job type and passed to the app for build-file job type.
Payload example:
// strings should be in "new-line delimited json" format if they passed by URL
[{ // non plural string
"previewId": 1, // only for "parse-file" jobType, required when the HTML preview of the file is generated
"id": 1, // only for "build-file" jobType
"identifier": "string-key-1", // required
"context": "Some context", // optional
"customData": "max 4 KB of custom data", // optional
"maxLength": 10, // optional, default null
"isHidden": false, // optional, default false
"hasPlurals": false, // optional, default false
"labels": ["label-one", "label-two"], // optional, default []
"text": "String source text", // required
"translations": { // optional
"uk": { // targetLanguage.id
"text": "Переклад стрічки", // required
"status": "untranslated | translated | approved" // optional, default "translated"
},
// can be other languages for multilingual, check "targetLanguages" in the request payload
}
},
{ // plural string
"previewId": 2,
"id": 2,
"identifier": "string-key-2",
"context": "Some optional context",
"customData": "max 4 KB of custom data",
"maxLength": 15,
"isHidden": false,
"hasPlurals": true,
"labels": [],
"text": { // keys from sourceLanguage.pluralCategoryNames
"one": "One file",
"other": "%d files",
},
"translations": {
"uk": {
"text": { // keys from targetLanguage.pluralCategoryNames
"one": "One file",
"few": "%d файла",
"many": "%d файлів",
},
"status": {
"one": "untranslated",
"few": "translated",
"many": "approved",
}
}
}
}]
Properties:
previewId | Type: Required: yes (only for the Description: Numeric identifier of the string in the HTML Preview file. Used for |
id | Type: Description: Numeric identifier of the string in your Crowdin Enterprise project. Used for |
identifier | Type: Description: Unique string key within the file. |
customData | Type: Description: Any custom data that need to be linked to the string. Added custom data will be exported along the corresponding strings on translation export. |
HTML Preview of the file
HTML Preview of the file example:
<html lang="en">
<head>
<title>Optional Title</title>
<style>
table, th, td { border: 1px solid #aaa; }
</style>
</head>
<body>
<h1 style="text-align: center">HTML preview of the file</h1>
<table style="width: 100%">
<tr>
<th>Key:</th>
<th>Text:</th>
</tr>
<tr>
<td>Key 1</td>
<td><span id="string_preview_id_1">Source Text 1</span></td> <!-- 1 is previewId in strings json -->
</tr>
<tr>
<td>Key 2</td>
<td><span id="string_preview_id_2">Source Text 2</span></td> <!-- 2 is previewId in strings json -->
</tr>
</table>
</body>
</html>
The context menu module allows creating the item in the context menu where it’s possible. Currently, the module can be added to the following context menus:
Also, this module can perform the following types of actions:
This module is available to all authorized users.
Context menu module structure:
{
"context-menu": [
{
"key": "your-module-key",
"name": "Module name",
"description": "Module name",
"options": {
"location": "/modal",
"type": "modal"
}
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. Uses as Context menu text |
description | Type: Description: A human-readable description of what the module does. |
options.location | Type: Required: yes Allowed values: Description: The location in UI where the context menu can be added. |
options.type | Type: Required: yes Allowed values: Description: The type of action this module will perform. |
environments | Type: Allowed values: Description: Set of environments where a module could be installed. |
The modal module allows creating a new modal dialog. The current module works only with the Context menu module that opens it.
Modal module structure:
{
"context-menu": [
{
"key": "your-module-key",
"name": "Module name",
"url": "/module-url"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. Uses as Context menu text |
url | Type: Required: yes Description: The relative URL to the content page of the module that will be integrated into the UI. |
environments | Type: Allowed values: Description: Define the environment in which the module will run. |
To use a module in your app, declare the module in your App Descriptor file under modules, including any required properties. The properties you include control the customization options for your module.
Basic module structure:
{
"{module_type}": [
{
"key": "your-module-key",
"name": "Module Name"
}
]
}
Properties:
{module_type} | Type: Required: yes Allowed values: Description: The type of module Crowdin app uses. |
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |