Frequently Asked Questions

Product Overview & Integration

What is the Hygraph-Lokalise integration?

The Hygraph-Lokalise integration connects Hygraph, a headless CMS, with Lokalise, a localization management platform. This integration enables teams to streamline localization workflows by allowing bulk imports and exports of content, manage multiple locales, and handle translations directly within the Hygraph interface. It is designed to simplify the process of translating and managing multilingual content for digital products such as websites and applications. Source

What can I do with the Hygraph-Lokalise integration?

With the Hygraph-Lokalise integration, you can:

Source

What are the prerequisites to use the Hygraph-Lokalise integration?

To use the Hygraph-Lokalise integration, you need:

Note: Apps are environment-specific, so configuration applies per environment. Source

Setup & Usage

How do I install the Lokalise app in Hygraph?

To install the Lokalise app in Hygraph:

  1. Go to the Hygraph Marketplace and select the Lokalise app.
  2. Select the Hygraph project where you want to install the app and click Add App.
  3. Enter your Lokalise API token and Project ID (found in your Lokalise account).
  4. Select at least one model to use Lokalise with (this can be edited later).
  5. Click Save to complete the installation.
Source

How do I export content from Hygraph to Lokalise for translation?

To export content from Hygraph to Lokalise:

  1. Navigate to the content editor in Hygraph.
  2. Select Lokalise under the App views section of the right sidebar.
  3. Use the checkboxes to select the content you want to export.
  4. Click Submit to Translate at the top of the form.
  5. Select the locales to export and click Export translation.
Supported fields for export include single-line text, multi-line text, markdown, richtext, and slug fields. Source

How do I import translated content from Lokalise back into Hygraph?

To import translated content from Lokalise into Hygraph:

  1. Go to the Lokalise section of the content editor in Hygraph.
  2. Select the entries you want to import translations for.
  3. Click Import Translation at the top of the form.
  4. Select the languages of the content being imported and click Import translation.
The translation status will update to Imported once the process is complete. Supported fields for import are the same as for export. Source

What field types are supported for translation with the Hygraph-Lokalise integration?

The following field types are supported for export and import with the Hygraph-Lokalise integration:

Export and import are also supported for Basic and Modular Components, but only for the supported field types. Source

How do I view and manage translation statuses in Hygraph?

In the Lokalise app view of the Hygraph content editor, you can view the localization status of your content and manage translations in bulk. Statuses include:

Source

What should I do if I encounter issues with localization fields or languages?

If the content editor displays the message "This model has no localized fields" but you have localizations configured in the schema editor, check your project settings under Project settings > Locales. Ensure your project has at least two languages configured. Free plans can have a maximum of 2 locales. Source

Features & Capabilities

How does the Hygraph-Lokalise integration help with multilingual content management?

The integration allows teams to easily scale localization efforts and maintain high-quality content across all languages. By centralizing translation workflows, it ensures that your message remains clear and on-brand in every locale. The integration supports bulk imports/exports and provides a dedicated interface for managing translations. Source

What are the benefits of using Lokalise with Hygraph?

Benefits include:

Source

Can I manage which models use Lokalise in my Hygraph project?

Yes, you can manage which models use Lokalise by navigating to Apps > Lokalise in your Hygraph project, clicking the pencil icon to edit, and using the checkboxes to select or deselect models. Only content created using the selected models will be available for translation via Lokalise. Source

Technical Requirements & Troubleshooting

Are there any limitations on the number of locales in Hygraph's free plan?

Yes, free plans in Hygraph can have a maximum of 2 locales. If you need to manage more than 2 locales, consider upgrading your plan. Source

What should I do if my localized fields are not appearing in the content editor?

If your localized fields are not appearing, ensure that the fields are set as localized in the model schema and that your project has at least two languages configured in Project settings > Locales. Only localizable fields can be submitted to Lokalise. Source

Use Cases & Business Impact

Who can benefit from the Hygraph-Lokalise integration?

The integration is ideal for teams managing multilingual digital products, such as websites and applications, who need to streamline localization workflows. It is especially beneficial for content creators, localization managers, and developers working in organizations that require efficient translation management and consistent global content delivery. Source

How does the Hygraph-Lokalise integration impact business operations?

The integration helps businesses scale their localization efforts, reduce manual work, and ensure high-quality, consistent content across all languages and markets. By centralizing translation management, teams can accelerate time-to-market for global products and maintain brand consistency. Source

Support & Resources

Where can I find more information or support for the Hygraph-Lokalise integration?

You can find detailed setup guides and troubleshooting tips in the Hygraph-Lokalise integration documentation. For further assistance, refer to the Lokalise documentation or contact Hygraph support via their contact page.

Pricing & Plans

Are there any costs associated with using the Hygraph-Lokalise integration?

While the integration itself is available through the Hygraph Marketplace, both Hygraph and Lokalise require separate accounts, and usage may be subject to the pricing plans of each platform. For example, Hygraph's free plan allows up to 2 locales. For more details, visit the Hygraph pricing page and Lokalise pricing page.

Help teams manage content creation and approval in a clear and structured way
Hygraph
Docs
You are currently reading the Studio Docs. If you were looking for the Classic Docs check here

#Connect your Hygraph project to Lokalise

Lokalise is a localization management platform where teams can easily build and manage workflows for multiple locales and translations of existing content. It enables teams to build collaborative workflows around localization, ensure high quality translations are pushed live, and create new locales for a wide range of digital products, from applications to websites.

#What you can do with the Hygraph-Lokalise integration

  • With the Hygraph-Lokalise integration, teams can simplify their workflows between Lokalise and Hygraph by creating bulk imports and exports of content and easily manage multiple locales for their digital products through a dedicated interface within Hygraph.

#Prerequisites to use this integration

  • You must have a Hygraph account. If you don't have one, you can create one here.
  • You must have a Hygraph project.
  • You must have a Lokalise account. If you don't have one, you can create one here.
  • You must have a Lokalise project. The project type must be Software localization, and you must select a base language for your project in your project settings.
  • You must create a Lokalise API Token.

#Install the Lokalise app

Click here to install the Lokalise App on Hygraph, then follow these steps:

Lokalise installationLokalise installation

  1. In the dropdown, select which project you want to install the app in, then click on the Add App button. You should be redirected to your Hygraph project dashboard.
  2. Fill in the API token and the Project ID. This information can be found in your Lokalise account. The Hygraph UI provides links that show you how to get the information you need next to each requested field.
  3. Select at least one model to use Lokalise in. This information can be edited later by going to the Apps section of your Hygraph project, then clicking on the pencil icon in the Lokalise card to edit the details.
  4. Click on the Save button.

#Use Lokalise in your Hygraph project

As you create content, it will display in the Lokalise section of the Content editor, under App views. From there, you will be able to export content to Lokalise to be translated, then import those translations into Hygraph.

Finally, after the process has been completed, you will be able to view the translated content normally by accessing the Content editor.

Take into account that only localizable fields can be submitted to Lokalise. So the fields must be set as localized fields when added to the model.

Localized field checkboxLocalized field checkbox

You will find the Localized field checkbox at the bottom of the field details screen, which displays when you create or edit a field in the Schema editor.

#Export translation

Submit to translateSubmit to translate

  1. Navigate to the content editor.
  2. Select Lokalise under the App views section of the right sidebar.
  3. Use the checkboxes to select the desired content from the list, and send it to Lokalise by clicking on the Submit to Translate link at the top of the form.
  4. A pop-up will display, where you need to select the locales to export. Select the necessary checkboxes, and click on the Export translation button.
  5. The translation status will change to In progress, and you will be able to find the content ready to translate in your Lokalise account.

If the content is exported successfully, a green message will pop up in the lower right corner of the screen indicating this. If it fails, a red message will be displayed in the same place indicating that the submit was unsuccessful.

The following fields are supported to be exported to Lokalise:

  • Single-line text
  • Multi-line text
  • Markdown
  • Richtext
  • Slug

Export is also supported for Basic and Modular Components, but only for the supported field types.

#Import translation

After exporting content to Lokalise, it will be translated and saved there. You can then import that content back to Hygraph by following these steps:

Import translationImport translation

  1. Navigate to the Lokalise section of the Content editor. Use the checkboxes to select the entries that you want to import translations for, then click on the Import Translation link at the top of the form.
  2. A pop-up will display, where you need to select the language or languages of the content being imported. Select the necessary checkboxes, and click on the Import translation button. The translation status will change to Imported as a result.

The following fields are supported to be imported from Lokalise:

  • Single-line text
  • Multi-line text
  • Markdown
  • Richtext
  • Slug

Import is also supported for Basic and Modular Components, but only for the supported field types.

#Translation statuses

The Lokalise app view of the Content editor contains a form that allows you to view the localization status of your content as well as to export and import translations in bulk.

Lokalise secton in App viewLokalise secton in App view

Your Locale status refers to the default language in your project. The language will be indicated next to the column title, i.e. Locale status (en).

Your Global status refers to all the languages that were submitted for translation.

StatusDescription
MissingIndicates that an entry has never been sent to Lokalise.
In progressIndicates that an entry has been submitted for translation.
DoneIndicates that all translations have been finished in Lokalise, marked as reviewed, and imported.
ChangedIndicates that an entry has been edited after it was sent to Lokalise.
ImportedIndicates that one or more translations - but not all - have been finished in Lokalise, and imported to Hygraph.

#View translations

  1. Navigate to the content editor, and select the view of the model you included Lokalise in.
  2. Edit an entry that you imported a translation for by clicking on the pencil icon. The content will display at the center of the screen.
  3. You will find the Localizations section in the right sidebar. You have the following options:
    1. Click on the + icon to add a translation.
    2. Click on the trash icon to delete a translation.
    3. Click on the eye icon to view a translation in the editor.

View translationsView translations

#Troubleshooting

If the Content Editor displays the message This model has no localized fields under localizations in the sidebar, while the Schema Editor has localizations configured, go to Project settings > Locales. There, make sure your project has at least two languages configured.

Locales in project settingsLocales in project settings

If you have only one language configured there, select another language for localizations using the Display name dropdown, then click on Add.

#Resources