Prerequisites
- A Zendesk Help Center with content to import
- An API token generated by a user with read access to Help Center content
- The email address of the user who created the token
Important: API Token is Tied to a Zendesk User Zendesk API tokens are linked to the user who created them. There is no native “service account” in Zendesk.If the user is deactivated or loses permissions, the API token will stop working.
- Recommended: Use an Admin user for reliable access
- Best Practice: Create a dedicated user for integrations (e.g.,
ago-integration@yourcompany.com)
Generating a Zendesk API Token
- Go to Zendesk Admin Center > Apps and integrations > APIs > Zendesk API
- Click the Settings tab
- Enable Token Access
- Click Add API token
- Copy the generated token (you won’t be able to see it again)
Setup Steps
- Navigate to Knowledge > Sources > Create
- Select Zendesk as the connector type
- Enter your Zendesk subdomain (e.g.,
support-company) - Enter the email of the API token owner
- Enter your API token
- Configure the settings below as needed
- Save and run a manual sync
Configuration
Label Filtering
When a label filter is set:- Articles without labels are always imported
- Articles with labels are imported only if at least one label matches the filter
["public", "faq"]:
- Article with no labels — imported
- Article with labels
["public"]— imported - Article with labels
["faq", "internal"]— imported - Article with labels
["internal", "draft"]— not imported
Turn Labels Into Text The Assistant Can Read
Help Centers often use an article label to draw a badge: which plan a feature needs, “beta”, “deprecated”, which region or role it applies to. That badge is an image rendered by the theme, so the assistant never sees it — it can walk a customer through a feature without ever mentioning the condition attached to it. The connector can turn any label into a sentence added at the top of the article. There is no form field for it yet: open your source, switch the configuration panel to Advanced (JSON), and add alabel_sentences entry next to the other settings.
- One entry per label, one sentence each. Write it in the language your knowledge base is mainly written in — the sentence is read by the assistant, which answers in whatever language the customer writes in, so it does not need to be translated.
- Write the sentence as the condition it stands for, including what it excludes. The assistant does not infer that a Business feature is unavailable on Starter from a list of included plans.
- Articles whose label is not in the mapping get no sentence, and an article with no label makes no claim at all — the absence of a badge is never read as “this applies to everyone”.
- Labels belong to the article, not to its translations, so the same sentence is added to every language you import.
- The sentence is regenerated at every sync, so re-labelling an article in Zendesk is enough to update it. Nothing to maintain on the AGO side.
- Switching the panel back to the form keeps the entry: settings the form does not show are carried over when you save.
What Gets Imported
The connector preserves the Zendesk hierarchy:- Categories: Top-level organizational units
- Sections: Sub-categories within each category
- Articles: Individual knowledge base articles with content converted from HTML to Markdown
- Attachments: Article attachments are downloaded and stored
Best Practices
- Use category or section filters for large Help Centers to import only relevant content
- Schedule regular syncs to capture content changes
- Create a dedicated Zendesk user for the integration to avoid disruption if a personal account is deactivated
Troubleshooting
Authentication failed
Authentication failed
- Verify the API token is correct and not expired
- Ensure the email address matches the token owner
- Check that API access is enabled in Zendesk Admin Center
Missing content
Missing content
- Verify the user has read permissions for Help Center content
- Check that content exists in the specified locale
- Review category/section/label filters — they may be excluding content
Attachment download failures
Attachment download failures
- Check network connectivity to Zendesk
- Verify attachment storage configuration in AGO
Related
- Knowledge Connectors — All available connectors
- Zendesk Ticketing Integration — Zendesk ticketing connector
- Knowledge Source Management — Managing sources
