Skip to content

Connect Zendesk

Push your published Topicary documentation to Zendesk Help Center as articles. The integration keeps content in sync: publish in Topicary and updates flow to Zendesk automatically.

Before you begin

This feature requires the Enterprise capability tier (the Business ). During the beta, every project is on the free Solo tier, so this feature is locked by default: go to Settings ▸ Billing and request Enterprise access to unlock it.

Only project members with the Admin can configure this feature. Authors and Reviewers do not have access to these settings.

Connect your Zendesk account

  1. Go to Settings in the sidebar.

  2. Open the Integrations tab.

  3. Click Add Integration and select the Zendesk provider.

  4. Enter your Zendesk subdomain (the yourcompany part of yourcompany.zendesk.com).

  5. Enter the email address associated with the API token.

  6. Enter a Zendesk API token (generate one in Zendesk Admin > Apps and Integrations > APIs > Zendesk API).

  7. Click Test Connection to verify the credentials.

  8. Once the connection succeeds, give the integration a name and click Create.

Sync content

After connecting:

  1. Go to Settings > Integrations and select your Zendesk connection.

  2. Select the publication target whose content should sync to Zendesk.

  3. Click Sync Now.

Topicary publishes each topic in the selected target as a Zendesk article. The article title, body, and section placement are set automatically based on your map structure.

Only published content is synced. Draft and in-review topics are not pushed to Zendesk.

Sync behavior

  • New topics become new Zendesk articles.

  • Updated topics overwrite the corresponding Zendesk article with the latest published content.

Content is compared using a content hash. If the published content has not changed since the last sync, the article is skipped.

Sync pushes published content to Zendesk. It does not delete Zendesk articles. If you remove a topic in Topicary, delete the matching article in Zendesk manually.

Divergence detection

Topicary detects when articles have been edited directly in Zendesk since the last sync. A warning badge appears on the Integrations tab showing which articles have been modified outside of Topicary. When you trigger a sync, you will see a warning before overwriting those external changes, giving you the opportunity to review the differences first.

Syncing overwrites Zendesk articles with Topicary content. Any edits made directly in Zendesk will be lost on the next sync. Treat Topicary as the single source of truth for synced content.

See also

Was this page helpful?