Skip to main content
Zendesk Guide

Exchange data with Zendesk Help Center.

Ilya Krukowski avatar
Written by Ilya Krukowski
Updated over 3 weeks ago

This feature is available from the Pro plan and above.

Use the Zendesk Guide app in Lokalise to translate your Zendesk Help Desk content efficiently.

Prerequisites

Enabling localizations

Before translating, you may want to add the target languages for your help center. This can be done in the Zendesk Admin Center under Account > Localization.

Adding languages to the help center

Go to Help center settings > Language settings and select the languages you need. Click Add new language if you want to create more.

Other considerations

To export and manage translated content, your Zendesk profile must have permissions to modify Zendesk Guide content. The user who installs the Zendesk Guide app should have admin or agent access with publishing permissions to create and update articles.


Integrating Zendesk Guide with Lokalise

Create Lokalise project

If you haven’t already, create a Marketing and support project in Lokalise.

Enter a project name, select the base and target languages, and choose Zendesk Guide from the Content integration dropdown.

Click Create project to finalize the setup.

Installing the app

Once the project is created, you should be redirected to the Content management tab. If this doesn’t happen, open your Marketing and support project manually, go to the Content management tab, and click Install.

A dialog will appear asking for your Zendesk subdomain. If your help center URL is mycorp.zendesk.com, then the subdomain is mycorp.

Click Authorize and allow Lokalise to access your Zendesk project.


Importing items

This app supports automated import. You can find more details in the corresponding article.

Once you authorize, a list of sections, categories, and articles will appear. Select the items you need and click Import selected to bring them into your Lokalise project for translation.

A dialog will appear where you can adjust import settings:

  • Import languages – choose one or more languages to import. Any missing languages will be automatically added to your Lokalise project.

  • Overwrite updated translations – enable this if you want to update previously imported translations with the latest content from Zendesk.

  • Skip key creation for empty translations – prevents Lokalise from creating keys for empty Zendesk items.

  • Assign tags – add tags to translation keys based on the selected content. For example, choosing Title will tag keys with their corresponding article titles.

Click OK to start the import. The process will run in the background, and you can track its status on the Activity page.

To refine your selection, use the Filter dropdown or the search box in the top right corner.


Performing translations

Once the items are imported and new keys are created, you can begin translating them as usual.

If you enabled Assign tags during the import process, each newly created key will have the following tags:

  • Zendesk Guide – identifies content related to Zendesk Guide.

  • title or body – indicates whether the key corresponds to an article title or body text.

  • Item type tag – specifies whether the key belongs to an article, section, or category.

  • Content-specific tag – uses the name of the corresponding post, section, or category for easy identification.


Exporting to Zendesk Guide

This app supports automated export. More details can be found in the corresponding article.

Once translations are complete, go to the Content management tab in your Lokalise project, select the items you want to export, and click Export selected.

In the export dialog, choose the languages to export. If needed, enable Don't export empty translations to avoid exporting untranslated content. The selected languages will then be updated in Zendesk.


Reimporting from Zendesk guide

If any changes were made in Zendesk, you can update the corresponding Lokalise keys by reimporting content. Under the Content management tab, select one or more linked items and click Import selected to bring in the latest updates.


Known limitations

  • The Zendesk API has some limitations when handling content blocks. These blocks will be exported and translated as plain text, meaning that after exporting from Lokalise, you may need to manually check and update translated articles to ensure the correct content block formatting is in place.

  • Lokalise can only sync categories, sections, and articles that already exist in your Zendesk Help Center. New content must be created in Zendesk before it can be imported into Lokalise.

Did this answer your question?