Skip to main content

Sync a Zendesk Help Center

A Zendesk Help Center connection copies the published articles of chosen Help Center categories into a folder in your workspace and keeps that copy current once a day. Agents that can search the folder answer from the same articles your customers read. For the developer-facing sync contract, see the CRM and data sync guide.

Before you start​

You need permission to manage App Connections and to add files to the destination folder. The Zendesk Help Center connection must also be turned on for your workspace: if you don't see Zendesk Help Center in the App Connections directory, ask your Gravity Rail administrator to turn on the zendesk feature.

Confirm these with the Help Center's owner:

  • The Help Center is public: the articles you need are readable without signing in. Private Help Centers are not supported yet.
  • The Zendesk subdomain — the part before .zendesk.com — and the one locale to copy, such as en-us.
  • The IDs of the categories to copy. Only articles in these categories are synced.
  • The content is general help material, not information about specific people.

Pick or create the destination folder first. The connection does not create folders or change who can see them.

Create the connection​

  1. Open App Connections, go to the Directory tab and choose Zendesk Help Center.
  2. Fill in the settings below and select Create connection.

The connection is created with sync paused, and you become its sync owner: articles are written into the folder as you. Nothing is fetched from Zendesk until you resume the sync, and saving does not check that the Help Center is reachable.

SettingWhat it does
Help Center URLThe public address customers visit. Shown for reference only.
Zendesk subdomainWhere articles are fetched from (<subdomain>.zendesk.com).
LocaleThe one Help Center language to copy.
Category IDsThe categories to copy, separated by commas.
Destination folderThe folder the articles are written into.
Source labelWritten into each file so you can tell where it came from.
Remove withdrawn articlesWhen on, an article that is unpublished or leaves these categories is deleted from the folder.

Resume, pause and run a sync​

Open the connection from the Active tab with Settings. The settings window shows the sync controls, the settings and the run history together.

  • Turn on Sync enabled and save to resume the daily sync. Turn it off to pause; files already synced stay in the folder.
  • Sync Now runs a sync immediately. Full re-sync rewrites every article, for example after images failed to load.
  • There is no preview run: every sync updates the folder.

Each run lists one item per article: created, updated, unchanged, failed or deleted. A failed article keeps its last good copy and is tried again on the next run.

Change the settings​

You can edit any setting. After a change, the next run copies the new selection in full. Articles outside the new categories or locale are removed when Remove withdrawn articles is on. Changing the destination moves the synced files to the new folder; you need permission to add files to both folders.

How syncing behaves​

  • Each article becomes one markdown file, with its screenshots saved beside it in the same folder. If a screenshot cannot be downloaded, the article keeps the image's web address until it changes or you run a full re-sync.
  • Files the sync did not create are never changed or deleted, even if they have the same name.
  • If Zendesk cannot list a category completely, the run stops before writing or deleting anything.
  • Indexing the new content can take a few minutes after a run finishes.

For developers​

The sync contract, including how run modes and deletions behave, is in the CRM and data sync guide.