Coveo for Zendesk can be integrated in two types of services: Zendesk Support, which is the agent interface, or Zendesk Guide, which is a customizable self-service knowledge base. By adding a Zendesk source to your Coveo organization, your content is added to the index, and then appears in query results for agents and end users.
Integration for Zendesk Support
Zendesk Support uses the Agent Dashboard, which appears when you log in. The dashboard is a ticketing system designed to help agents track customer interactions. Coveo for Zendesk instantiates different sections of the dashboard in order to provide you with personalized recommendations.
To ensure user authentication, the Coveo-hosted search page in Zendesk will use a Zendesk server-side app to generate a JWT token. This token contains user information and is specifically for your Coveo organization. Once the token is sent, Coveo generates a search token based on the information retrieved (see Building a server-side app - Bonus part: Secure the app for more information).
Only the user information is used to create the token.
A search hub is enforced in the token with the default value,
<Location> are replaced by the information provided by the Zendesk JWT token.
Neither the search hub nor the Coveo-generated token are customizable, therefore additional filters or identities can’t be injected.
The Ticket Sidebar component on the Agent Dashboard contains data pertaining to the ticket context.
This is where the Insight panel is embedded, allowing the ticket context to be leveraged and allowing the user to retrieve relevant items.
CoveoJsSearch library renders the Insight panel search interface.
The ticket data is retrieved with the Zendesk Client API after which the context is flattened and modified for readability by Coveo.
The Top Toolbar component is visible at the top of the Agent Dashboard. The toolbar consists of icons which allow you to access different functionalities such as creating a new ticket or opening a search box. This component doesn’t have access to the ticket; instead, it takes care of the initialization and communicates with the Insight panel to retrieve the context of the ticket and updates accordingly.
Integration for Zendesk Guide
Zendesk Guide is a knowledge base designed for end users which uses the self-service Help Center that can be customized according to the customer’s needs. The self-service integration is set up by implementing a Coveo search box in the Help Center and also by replacing the home page with a built-in Coveo search page that allows end users to search for relevant content.
At the moment, Zendesk Guide doesn’t support server-side apps. Contrary to the JWT search token which ensures user authentication in Zendesk Support, an API key is used instead to implement the Coveo search box in Zendesk Guide.
As a result, user identities aren’t supported in the integration, meaning that logged-in users are treated as anonymous users and can only access public Zendesk articles but can’t access any secured Coveo content. For more information on the API key authentication method, see API Key Authentication.