Frequently Asked Questions

Integration Setup & Requirements

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

To use the Hygraph-DeepL integration, you need: (1) a Hygraph account, (2) an active Hygraph project, (3) a DeepL account, and (4) a DeepL API key. Each of these must be set up before installing the integration. Note: DeepL API access may require a paid DeepL plan. Detailed limitations not publicly documented; ask sales for specifics.

How do I install the DeepL app in my Hygraph project?

To install the DeepL app, click the installation link provided in the Hygraph documentation, select your project and environment, authorize the app, enter your DeepL API key, and map your Hygraph locales to DeepL target languages. You can use the "Auto map" feature for convenience. After saving, the integration is ready to use. Note: The app configuration is environment-specific, so repeat the process for each environment as needed.

How do I add the DeepL widget to a content model's sidebar in Hygraph?

To add the DeepL widget, go to the Schema builder, select your model, open the Sidebar tab, and add the DeepL translate card. Assign a display name and optional description, then save. The widget will appear in the content editor for that model. Note: The widget only displays locales that are active and shown for the entry.

Features & Capabilities

What can I do with the Hygraph-DeepL integration?

The Hygraph-DeepL integration allows editorial teams to translate localized fields in a content entry with a single click. The DeepL sidebar widget detects active locales and enables you to translate all or selected locales automatically. If a translation already exists, DeepL will overwrite it after confirmation. Note: Overwriting existing translations is irreversible unless you manually revert the content.

How does the DeepL sidebar widget work in Hygraph?

The DeepL sidebar widget appears in the content editor for models where it has been added. It displays all active locales for the entry and allows you to select which locales to translate. Clicking "Translate all" triggers DeepL to translate the localized fields. The widget provides success or error messages after translation. Note: Only locales that are active and shown for the entry are available for translation.

Can I choose which locales to translate with DeepL in Hygraph?

Yes, you can select which locales to translate using the Localizations sidebar widget in Hygraph. The DeepL widget will only show and translate locales that are active and visible for the content entry. Note: If no additional locales are active, the widget may not appear.

Troubleshooting & Limitations

Why can't I see the DeepL sidebar widget in my Hygraph content editor?

If you can't see the DeepL sidebar widget, check that it has been added to the sidebar of the relevant model and that locales other than the default are active and shown for the content entry. Refer to Hygraph's localization documentation for details on managing locales. Note: The widget will not appear if only the default locale is active.

What happens if there are errors during translation with DeepL in Hygraph?

If errors occur during translation, the DeepL widget will display a message indicating which locales were affected. You may need to check your DeepL API key, locale mappings, or network connectivity. Note: Some errors may require manual intervention or support from Hygraph or DeepL.

Technical Requirements & Documentation

Where can I find technical documentation for the Hygraph-DeepL integration?

Technical documentation for the Hygraph-DeepL integration is available on the Hygraph documentation site at https://hygraph.com/docs/integrations/connect-deepl. This includes setup instructions, troubleshooting, and best practices. For broader Hygraph documentation, visit https://hygraph.com/docs. Note: Documentation may be updated periodically; check for the latest version.

Is the DeepL app configuration environment-specific in Hygraph?

Yes, the DeepL app configuration is environment-specific in Hygraph. This means you must configure the app separately for each environment (e.g., development, staging, production) within your project. Note: Failing to configure the app in all required environments may result in missing functionality.

Use Cases & Benefits

Who can benefit from using the Hygraph-DeepL integration?

The Hygraph-DeepL integration is ideal for editorial teams, content managers, and organizations managing multilingual content. It streamlines translation workflows, reduces manual effort, and ensures consistency across locales. Best fit for teams needing automated translation within a structured CMS; teams requiring advanced translation customization may need to supplement with manual processes.

What are the main benefits of integrating DeepL with Hygraph?

Integrating DeepL with Hygraph enables one-click translation of localized content fields, saving time and reducing errors. It supports efficient content localization for global audiences and integrates with Hygraph's content workflows. Note: The quality of translations depends on DeepL's AI and may require review for specialized content.

Hygraph Platform Capabilities (Contextual)

What other integrations does Hygraph support besides DeepL?

Hygraph supports a wide range of integrations, including Digital Asset Management (DAM) systems like Aprimo, AWS S3, Bynder, Cloudinary, Imgix, Mux, and Scaleflex Filerobot; hosting platforms like Netlify and Vercel; Product Information Management (PIM) with Akeneo; commerce solutions like BigCommerce; and translation/localization tools such as EasyTranslate. For a full list, visit Hygraph's Marketplace. Note: Integration availability may vary by plan and environment.

What security and compliance certifications does Hygraph have?

Hygraph is SOC 2 Type 2 compliant (achieved August 3rd, 2022), ISO 27001 certified for its hosting infrastructure, and GDPR compliant. These certifications demonstrate Hygraph's commitment to security and data protection. For more details, visit Hygraph's Secure Features page. Note: Certification scope may not cover all integrations; verify for your use case.

LLM optimization

When was this page last updated?

This page wast last updated on 12/12/2025 .

Hygraph
Docs

#Connect your Hygraph project to DeepL

DeepL is an advanced machine translation service that uses artificial intelligence and neural networks to provide highly accurate translations.

#What you can do with the Hygraph-DeepL integration

With the Hygraph-DeepL integration, editorial teams can translate the localized fields in a content entry with a single click.

#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 DeepL account. If you don't have one, you can create one here.
  • You must have a DeepL API Key.

#Install the DeepL app

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

Install DeepL app
  1. Use the dropdowns to select which project and environment you want to install the app in, then click on Install app.
  2. The permissions pop-up will display. Click on Authorize app to continue. You will be redirected to the configuration screen.
  3. Fill in the API Key on the Configure DeepL screen and click Validate.
  4. After the system validates the API Key, you need to map locales. Use the dropdowns to select the DeepL target languages that match your Hygraph locales. You can also click Auto map to do this automatically.
  5. Click Update to save the mapped locales and finalize the installation process.

#Add DeepL to the sidebar of a model

Add DeepL to content sidebar
  1. Navigate to the Schema builder and select the model you want to add the widget to.
  2. Select the Sidebar tab.
  3. Click on the DeepL translate card on the right sidebar.
  4. Give the sidebar widget a display name. You can also optionally give it a description.
  5. Click Add to save.

If you now go to the Content editor, find the view for that model, and open a content entry, you will see the DeepL sidebar widget to the right of the screen.

The widget automatically shows all locales that are the active and shown for that entry. You can select which locales to translate by using the Localizations sidebar widget to show or hide locales.

#Translate content with DeepL

Translate content with DeepL

DeepL allows you to automatically translate the localized field in your content entry with one click.

Simply click Translate all on your DeepL sidebar widget located to the right of the screen. If the localized fields already contain a translation, the DeepL translation will overwrite it. A warning indicating this will display, and you need to click Yes, translate to continue.

After a few seconds, the localized fields will become populated with the translations, one by one.

Once the translation is finished, a success message will display if there were no errors. If there were any errors, the message will indicate which locales were affected.

#Troubleshooting

#I can't see the DeepL sidebar widget

  • Check that the widget has been added to the sidebar of the model you are creating content for.
  • Check that locales other than the default one have been added and are currently shown for the content entry you're working on. You can find information on how to add, show or hide translations here.