Content platforms

Connect Zendesk Guide

Import Zendesk Guide help center articles, sections and categories into transglot and publish reviewed translations as per-locale translations.

DirectionTwo-way
ImportedArticle title and body; section and category name and description
Written backA translation per target locale on each article, section or category. The source translation is never written
SyncSync from CMS
Per syncUp to 1,500 entries per content type
PlanStarter and above

Before you start

  • Add each target language to your help center in Guide's language settings. Zendesk rejects a translation for a locale that is not enabled there, and transglot reports that error rather than hiding it.
  • Create an API token in Zendesk's API settings (Zendesk API, token access). You connect with an agent's email address and that token.

Connect

Open your project's settings, choose CMS, and pick Zendesk Guide in the CMS list.

FieldWhat to enter
Zendesk subdomainOnly the subdomain, for example acme for acme.zendesk.com
Email + API tokenemail/token:api-token, for example agent@example.com/token:xxxxxxxx
Content typesAny of articles, sections, categories
Translatable fieldstitle and body for articles; name and description for sections and categories
Publish these localesThe target languages to write back

Select Connect, then Test connection. The test reads the help center's locales, which also proves Guide is enabled, and names the ….zendesk.com address it reached.

What gets imported

transglot reads the source text of each article (title and body), and of each section and category (name and description).

How translations are written back

Zendesk keeps each language as its own translation of the article (or section, or category). For each target locale, transglot updates the translation if it exists and creates it if it does not. An update changes only the fields being published, so a translation keeps its body when only the title changed.

Section and category names and descriptions are published as the translation's title and body. Language codes are converted to Zendesk's form, so pt_BR in transglot is published as pt-br.

A new translation needs both a title and a body. For articles, keep both title and body in Translatable fields.

Troubleshooting

  • ... the translation was rejected, title and body are required. The first publish of a locale needs both fields reviewed. Review the missing one, then publish again.
  • ... the credentials were rejected. Check the credential is in the form email/token:api-token and that token access is enabled.
  • ... the article or help center was not found. Check Zendesk subdomain, and that the article still exists.
  • ... the account is rate-limited, retry. Wait and run the sync or publish again.

On this page