Skip to main content

wxrks - Zendesk Connector

Configure the wxrks Zendesk connector to pull Help Center articles, sections, or categories into a translation project and sync the translations back to Zendesk.

This connector pulls content straight out of your Zendesk Help Center — individual articles, whole sections, or entire categories — into a wxrks translation project, then writes the finished translations back into Zendesk as new-language versions of that same content.

💡 Who is this for? This guide is for anyone with permission to configure connectors (typically an Account Admin) who also has admin access to Zendesk, specifically to generate an API token.


Step 1 — Start a new Zendesk configuration in wxrks

1. In wxrks, go to Integrations and search for or find the Zendesk tile.

2. Click Configure.

wxrks Integrations page with the Zendesk tile and Configure button

This opens the Configs list for Zendesk, where every existing configuration for your account is listed. Click Add Configuration to create a new one.

Zendesk Configs list with existing configurations and the Add Configuration button

In the dialog that opens, set Type to ZENDESK to load the connection fields covered in the next step.


Step 2 — Generate a Zendesk API token

In your Zendesk admin account, go to Admin Center > Apps and integrations > APIs > Zendesk API, then click Add API Token. Copy the generated token immediately — Zendesk only shows it once.


Step 3 — Fill in the connection details in wxrks

Back in the Add Configuration dialog, fill in:

  • Name — a label to identify this configuration in the Configs list.

  • Base URL * — your Zendesk account's base URL (for example, https://yourdomain.zendesk.com).

  • Username * — your Zendesk username, typically the email address you use to log in.

  • Token * — the API token you generated in Step 2.

  • Language Mapping — optional. Maps Zendesk locale codes to wxrks locale codes when they don't already match, in the format source=target, with multiple mappings separated by a semicolon. For example: en-us=en;cs=cs_cz.

Add Configuration dialog with Zendesk selected and Base URL, Username, Token, and Language Mapping fields

Click Save.


Step 4 — Create a translation project (sync)

From the Configs list, click Sync on the configuration you want to use. This opens a Create Project page where you define what gets pulled from Zendesk and how the resulting project is set up.

Create Project page for the Zendesk connector, with Organizational Unit, Contact Person, Project Reference, Type, and Request IDs fields

Fill in:

  • Organizational Unit * — where the new project is created.

  • Contact Person * — receives notifications about this project.

  • Project Reference * — a reference name for the new project.

  • Source Language / Target Languages — if left blank, the Organizational Unit's defaults are used.

  • Workflows * — the workflow steps the resulting Work Units will go through.

  • Type * — what the Request IDs below refer to:

    • Article — pulls one or more individual articles.

    • Section — pulls a section and every article inside it.

    • Category — pulls a whole category, including every section and article inside it.

  • Request IDs * — one or more Zendesk IDs matching the selected Type, separated by commas. See the next section if you're not sure where to find these.

  • Force Entry Creation — off by default. wxrks normally skips re-creating an entry that already completed successfully for the same content and language pair; turn this on to force a fresh entry anyway.

Click Sync to create the project.


Finding Article, Section, and Category IDs in Zendesk

Article IDs

  1. In the Zendesk admin panel, go to Help Center > Manage Articles.

  2. Open the article you need.

  3. The article ID is in the browser URL after /articles/. Example: https://yourdomain.zendesk.com/articles/123456789 → ID 123456789.

Section IDs

  1. Go to Help Center > Manage Sections.

  2. Open the section you need.

  3. The section ID is in the browser URL after /sections/. Example: https://yourdomain.zendesk.com/sections/987654321 → ID 987654321.

Category IDs

  1. Go to Help Center > Manage Categories.

  2. Open the category you need.

  3. The category ID is in the browser URL after /categories/. Example: https://yourdomain.zendesk.com/categories/1122334455 → ID 1122334455.


How translated content comes back to Zendesk

Once every Work Unit in the project is delivered, wxrks writes the translation back into Zendesk for each target language — creating a new article, section, or category translation if one doesn't exist yet for that locale, or updating the existing one if it does.

Translations are written back as drafts in Zendesk, not published live. Review and publish each translation from your Zendesk Help Center admin like you would any other Zendesk translation.

There can also be a short delay on Zendesk's side after delivery, while its system finishes processing and indexing the new content.


Troubleshooting

"Source language mismatch" when creating the project. The source language you selected doesn't match the default locale of the Zendesk Help Center you're pulling from. Set the project's source language to match, or fix the mismatch with a Language Mapping entry in Step 3.

"Missing article IDs, category IDs or section IDs." The Request IDs field was left empty, or didn't match the selected Type. Double-check both fields before clicking Sync.

"No translation found" when delivering. This means Zendesk doesn't have a translation slot for that target locale on that asset and wxrks couldn't find an existing one to update. Confirm the target language is actually enabled on your Zendesk Help Center.


Related articles

Did this answer your question?