Add or Edit a Zendesk Source

Index Content Coveo Relevance Cloud Developer System Administrator Product Documentation

When you have the required privileges, you can add the content of a Zendesk instance to a Coveo organization.

Tip
Leading practice

The number of items that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. See About Crawling Speed for information on what can impact crawling speed, as well as possible solutions.

Source Key Characteristics

Features Supported Additional information
Zendesk version Latest cloud version Following available Zendesk releases
Searchable content types check Organizations, users, groups, tickets, articles, article comments, and ticket and article attachments
Content update operations Refresh check

Takes place every hour by default.
Rescan check  
Rebuild check  
Content security options Same users and groups as in your content system check  
Specific users and groups check  
Everyone check  
Notes

  • Users may see limited results when performing searches against secured content while on Zendesk Guide sites (see Limitation).

  • If you set the content option to Everyone, we recommend that you apply additional filtering to ensure that your content is accessible by the intended audience.

Add or Edit a Zendesk Source

Follow the instructions below when adding or editing a Zendesk source.

"Sign in to Zendesk" Window

When adding the source, you must first authenticate with Zendesk in the Sign in to Zendesk window to allow Coveo to access your content.

Note

Your source authentication access token can potentially expire and become invalid. See Update an Access Token for information on how to update an expired access token.

  1. Enter your Zendesk subdomain, and then click Sign In.

    Example

    Your Zendesk environment URL is https://apples.zendesk.com, therefore you must enter apples.

  2. Enter the Email and Password of a Zendesk administrator account that has access to the desired content.

  3. Click Allow.

"Configuration" Tab

In the Add/Edit a Zendesk Source panel, the Configuration tab is selected by default. It contains your source general information, as well as other parameters.

General Information

Source Name

Enter a name for your source.

Tip
Leading practice

A source name can’t be modified once it’s saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens (-), and underscores (_). Avoid spaces and other special characters.
Optical Character Recognition (OCR)

If you want Coveo to extract text from image files or PDF files containing images, check the appropriate box. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable Optical Character Recognition for details on this feature.

Note

Contact Coveo Sales to add this feature to your organization license.

"Content to Include" Section

Options

Select the objects you want to make searchable. If you select Tickets, additional options appear:

  • Select Archived tickets and/or Deleted tickets if you want them to be indexed.

  • Under Filter by, select or enter the desired Organization or Tag if you want to index a subset of tickets.

Zendesk Locale

By default, Coveo indexes items in American English (en-us). If you want to index items in a different language, under Zendesk locale, enter the supported locale corresponding to this language.

Example

You enter de to index your content in German.

Note

The Zendesk source only supports one locale per source. Therefore, if you want to index content in two languages, you must create two sources.
Permissions

If you intend to select the Same users and groups as in your content system option in the Content Security section, in the Permissions tab, specify who should have access to the content. This parameter is ignored when you choose a different option.

"Content Security" Tab

Select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content Security.

"Access" Tab

In the Access tab, set whether each group and API key can view or edit the source configuration (see Resource Access):

  1. If available, in the left pane, click Groups or API Keys to select the appropriate list.

  2. In the Access Level column for groups or API keys with access to source content, select View or Edit.

Completion

  1. Finish adding or editing your source:

    • When you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon, click Add Source/Save.

      Note

      On the Sources (platform-eu | platform-au) page, you must click Launch build or Start required rebuild in the source Status column to add the source content or to make your changes effective, respectively.

    • When you’re done editing the source and want to make changes effective, click Add and Build Source/Save and Rebuild Source.

      Back on the Sources (platform-eu | platform-au) page, you can review the progress of your source addition or modification.

      Once the source is built or rebuilt, you can review its content in the Content Browser.

  2. Optionally, consider editing or adding mappings once your source is done building or rebuilding.

What’s Next?

Schedule source updates.