Zendesk Guides Knowledge Base Connector

  • Updated

Get Enterprise AI+

Do you want access to this new feature? Contact your Zingtree Account Manager or our Support Team.


Zingtree's AI Knowledge Search is powered by your knowledge articles. To configure the search, you'll connect your knowledge base(s) to the Zingtree. In just a few steps, we make it simple to connect to standard knowledge bases, including Zendesk Guides.

After establishing the connection to your knowledge base, you can select which articles to import into your AI Knowledge Search, creating new experiences for your users.


General Steps

  1. Enable API Token Access in Zendesk
  2. Generate API Token in Zendesk
  3. Provide Connector Details in Zingtree
  4. Select Category Groups
  5. Import the articles into Zingtree


What You’ll Need

  • Connector URL
  • Authorization Token


Configuration Details

Before proceeding, the Zendesk API Token needs to be enabled and generated to access knowledge base data from Zendesk.

Enabling API token access

API token access is disabled by default. You must enable API token access in the Zendesk Admin Center before you can use API tokens.

  1. In Admin Center, click Apps and Integrations in the sidebar, then select APIs > Zendesk API.
  2. In the Settings tab, enable token access.

Generating API tokens

To generate an API token, you must be an administrator, and API token access must be enabled in your account.

To generate an API token

  1. In Admin Center, click  Apps and Integrations in the sidebar, then select APIs > Zendesk API.
  2. Click the Add API token button.
  3. (Optional) Enter an API token description.
  4. Important Copy the token and paste it somewhere secure. When you click Save to close this window, the full token will never be displayed again.
  5. Click Save to return to the Zendesk API page.  If you click the token to reopen it, a truncated version of the token is displayed.

Generated API tokenzendesk-api-token-3.png

Truncated API tokenzendesk-api-token-4.png

Once you have your token, return to Zingtree and follow the steps below.  


Set Up your Connector

To connect your knowledge base to Zingtree:

  1. Log in to Zingtree and navigate to the Apps & Integrations section.
  2. Select External Sources in the left navigation.

Note If "External Sources" is not visible, your organization may not be enabled for AI Knowledge Search. Contact your Zingtree Account Manager.

On this page, choose the Zendesk Icon or the + Add Source button.


The next step, Connector Details, involves entering in key information about the connector so that a proper connection can be made to Zendesk and that your Connector is well described in the application for future identification.  


The required configuration for the Zendesk connector includes:

Give your connector a name for identification purposes. Example:

Acme Co Zendesk Guide Connector

A brief description of your Connector. Example:

Searches Acme account related knowledge base articles


Connector URL: The connector URL is constructed as https:// your Zendesk subdomain followed by .com/api/v2 Example:



Sub Domain Click here for instructions on finding your Zendesk Sub Domain


Authorization Token: This is the API Key that you created during the Zendesk setup portion of this article above. 


Authorized Zendesk Username: The email address of a Zendesk Administrator in your organization.


Language: Choose a language from those listed.



Choose Categories

The final step is selecting articles to import into Zingtree. These will be refreshed every 24 hours to keep your search updated. 

After configuring the knowledge articles for import, click Save Settings. Your connection is now ready for use in building Search widgets in Zingtree. To build search widgets using this connector go to Knowledge Search > Add Search Widget.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Didn't find what you need?

Our friendly customer support team is here to help

Submit a Ticket

Looking for help or advice?

Reach out to our knowledgeable community of users.

Zingtree Community