Skip to main content
Connic

Zendesk Help Center

By Connic
Auto-sync

Keep Zendesk Help Center articles in sync for agents

Publisher
By Connic
Syncs
Articles, Translations, Labels and sections
Set up in
Retrieval โ†’ Sources
Documentation
Retrieval Docs

How the Zendesk Help Center source works

Support teams keep their best answers in the Zendesk Help Center. The Zendesk source syncs those articles into Connic retrieval, so support and back-office agents answer from the published article instead of paraphrasing it.

Connect with the Zendesk subdomain and the locales to sync. Articles are read through the Help Center API instead of the rendered site, so custom domains and bot protection in front of the help center do not get in the way. Public help centers need no credentials, and an agent email with an API token adds articles restricted to signed-in users. Every article becomes one entry per locale and refreshes on the configured schedule.

What gets synced

Articles
Published article bodies, converted to clean text before chunking. Drafts are skipped.
Translations
Each configured locale is synced separately, so agents can answer in the customer's language.
Labels and sections
Article labels, section, and locale are kept in entry metadata so retrieval can be filtered.
Zendesk Help CenterActiveHelp center
Configuration
Sync behavior
Target namespacesources.zendesk
Sync intervalDaily
When content is deleted at the sourceRemove it from the retrieval
Recent syncsSync now
  • CompletedOct 13, 09:00 AM
    4 new ยท 11 updated ยท 1 removed
  • CompletedManualOct 12, 09:00 PM
    0 new ยท 2 updated ยท 0 removed
  • CompletedOct 12, 09:00 AM
    0 new ยท 6 updated ยท 0 removed

Set up the Zendesk Help Center source

Add the source under Retrieval โ†’ Sources in the environment your agents run in. Each environment keeps its own sources.

  1. Enter the Zendesk subdomain, e.g. example for example.zendesk.com. Help centers on a custom domain still use this subdomain.

  2. List the help center locales to sync, e.g. en-us, de.

  3. For a public help center, leave the email and API token empty.

  4. To include articles restricted to signed-in users, create an API token in Admin Center under Apps and integrations โ†’ APIs, and enter it with the email of an agent who can see those articles.

  5. Optionally limit the sync to category or section IDs, shown in the URL of each category or section page.

Configuration, in depth

Every available control for connecting Zendesk Help Center to a project.

Connection

Subdomain*
The Zendesk subdomain or its zendesk.com URL.
Agent email
Optional. Email of the agent the API token belongs to. Leave empty for a public help center.
API token
Optional. Zendesk API token. The sync only reads articles this agent can see.

Content scope

Locales*
Comma-separated help center locales to sync.
Category IDs
Only sync articles in these categories, comma-separated. Leave empty to sync the whole help center.
Section IDs
Only sync articles in these sections, comma-separated. Combines with the category IDs.

Sync behavior

Where synced content lands and how often it refreshes.

Target namespace
Retrieval namespace the synced entries are filed under. Use dots to nest, e.g. sources.notion.
Sync interval
How often the source is checked for changes. Each run only reprocesses content that changed.
When content is deleted at the source
Articles deleted, unpublished, or moved out of scope in Zendesk can be removed from the retrieval on the next sync, or kept as they were last synced.

Search it from an agent

Agents search synced content with the retrieval_query tool. A small tool that pins the namespace keeps an agent to this source.

tools/knowledge.py
from connic.tools import retrieval_query


async def search_zendesk(question: str) -> dict:
    return await retrieval_query(
        question, namespace="sources.zendesk"
    )
agents/support-agent.yaml
version: "1.0"

name: support-agent
type: llm
model: connic/gemini-3.7-flash
system_prompt: |
  Answer only from what search_zendesk returns.
tools:
  - knowledge.search_zendesk

Zendesk Help Center retrieval source FAQ

No. It reads articles through the Zendesk Help Center API, so the sync also works for help centers on a custom domain or behind bot protection that blocks crawlers.

Not for a public help center. Articles restricted to signed-in users or user segments need the email and API token of an agent who can see them. The sync only reads and never writes back to Zendesk.

Yes. List category or section IDs to sync only those articles, and list only the locales agents need.

Each configured locale is synced as a separate entry per article, with the locale stored in its metadata, so a query can be filtered to one language.