Tolgee icon

Tolgee

Interact with Tolgee API for translation management
Join our community

Actions5

Overview

This node integrates with the Tolgee API to perform a single-step import of translation keys and their associated data directly from a JSON body. It is designed for translation management workflows where you want to programmatically import or update translation keys, namespaces, screenshots, and translations in a Tolgee project.

Typical use cases include:

  • Automating bulk import of translation keys and their translations into a Tolgee project.
  • Syncing translation data from external sources or previous workflow steps into Tolgee.
  • Handling conflicts during import with configurable override modes and error handling.

For example, you might use this node to import new translation keys along with screenshots and translations for multiple languages, ensuring that existing translations are updated according to your conflict resolution preferences.

Properties

Name Meaning
Project Name or ID The identifier of the Tolgee project where the import will be performed. You can select from a list of projects or specify an ID using an expression.
Error On Unresolved Conflict A boolean flag indicating whether the import should fail completely if there are unresolved conflicts. If set to true, the import will not apply any changes when conflicts cannot be resolved and will report these conflicts as errors. If false, it applies all non-failed overrides and reports unresolved conflicts without failing entirely.
Keys The JSON object containing the keys to import. This must follow a specific format including key names, optional namespaces, screenshots (with positions and uploaded image IDs), and translations per language code. Translations also specify a resolution mode such as "EXPECT_NO_CONFLICT" or "OVERRIDE". This property supports expressions to dynamically reference data from previous nodes.
Override Mode Determines how the import handles protected or forbidden translations. Options are:
- Recommended: Fails on disabled translations and protected reviewed translations.
- All: Fails only on disabled translations but attempts to update protected reviewed translations if permissions allow.

Output

The node outputs JSON data representing the result of the import operation. This typically includes information about which keys were imported, any conflicts encountered, and the status of the import process.

  • The json output field contains the response from the Tolgee API after attempting the import.
  • If there are unresolved conflicts and Error On Unresolved Conflict is false, these conflicts are reported in the output.
  • No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Tolgee API.
  • Needs the Tolgee API domain URL configured in the credentials.
  • The node uses HTTP requests to communicate with the Tolgee API endpoints.
  • Proper permissions on the Tolgee project are necessary to perform imports, especially when overriding protected translations.

Troubleshooting

  • Failed to load projects or languages: This usually indicates issues with the API key or domain configuration. Verify that the API key is valid and has access to the specified Tolgee domain.
  • Import fails due to unresolved conflicts: If Error On Unresolved Conflict is set to true, the import will fail when conflicts cannot be automatically resolved. To handle this, either resolve conflicts manually or set this option to false to apply partial changes.
  • Permission errors when overriding translations: When using the "All" override mode, ensure the API key user has sufficient permissions to update protected reviewed translations; otherwise, the import will fail.
  • Invalid JSON format in Keys property: Ensure the JSON structure matches the expected format described in the property description, including correct nesting of keys, screenshots, and translations.

Links and References

Discussion