GETTING STARTED
SearchAssist Overview
SearchAssist Introduction
Onboarding SearchAssist
Build your first App
Glossary
Release Notes
What's new in SearchAssist
Previous Versions

CONCEPTS
Managing Sources
Introduction
Files
Web Pages
FAQs
Structured Data 
Connectors
Introduction to Connectors
SharePoint Connector
Confluence Cloud Connector
Confluence Server Connector
Zendesk Connector
ServiceNow Connector
Salesforce Connector
Azure Storage Connector
Google Drive Connector
Dropbox Connector
Oracle Knowledge Connector
DotCMS Connector
RACL
Virtual Assistants
Managing Indices
Introduction
Index Fields
Traits
Workbench
Introduction to Workbench
Field Mapping
Entity Extraction
Traits Extraction
Keyword Extraction
Exclude Document
Semantic Meaning
Snippet Extraction
Custom LLM Prompts
Index Settings
Index Languages
Managing Chunks
Chunk Browser
Managing Relevance
Introduction
Weights
Highlighting
Presentable
Synonyms
Stop Words
Search Relevance
Spell Correction
Prefix Search
Custom Configurations
Personalizing Results
Introduction
Answer Snippets
Introduction
Extractive Model
Generative Model
Enabling Both Models
Simulation and Testing
Debugging
Best Practices and Points to Remember
Troubleshooting Answers
Answer Snippets Support Across Content Sources
Result Ranking
Facets
Business Rules
Introduction
Contextual Rules
NLP Rules
Engagement
Small Talk
Bot Actions
Designing Search Experience
Introduction
Search Interface
Result Templates
Testing
Preview and Test
Debug Tool
Running Experiments
Introduction
Experiments
Analyzing Search Performance
Overview
Dashboard
User Engagement
Search Insights
Result Insights
Answer Insights

ADMINISTRATION
General Settings
Credentials
Channels
Team
Collaboration
Integrations
OpenAI Integration
Azure OpenAI Integration
Custom Integration
Billing and Usage
Plan Details
Usage Logs
Order and Invoices
Smart Hibernation

SearchAssist APIs
API Introduction
API List

SearchAssist SDK

HOW TOs
Use Custom Fields to Filter Search Results and Answers
Add Custom Metadata to Ingested Content
Write Painless Scripts
Configure Business Rules for Generative Answers

Zendesk Connector

You can easily configure SearchAssist to connect to the Zendesk application to enable users to fetch query results using the data and information available in Zendesk.

Specifications

Type of Repository  Cloud
Supported API version REST API v2
Search Results Support Zendesk knowledge base articles
Extractive Model for Answers Zendesk knowledge base articles
Generative Model for Answers Zendesk knowledge base articles

 

To configure Zendesk as a content source, it requires:

  • Configuring an OAuth application in Zendesk
  • Configuring the Zendesk connector in SearchAssist

Step 1: Setup an OAuth client in Zendesk

You need to add an OAuth client in the Zendesk application to generate OAuth credentials that SearchAssist will use to authenticate the requests sent to Zendesk. To do so, log in to the Zendesk application and go to the Admin Center.

Under Apps and Integration, select Zendesk API to build a custom integration with SearchAssist.  Add a new OAuth Client. 

Enter the details required for the client like name, description, company, etc. Set the Redirect URLs field to point to your SearchAssist instance. You can use one of the following callback URLs as per your region.

On saving the details, a pre-populated Secret field will appear on the lower side. This is the client secret specified in the OAuth2 spec. The client name along with the secret generated is required for configuration in the  SearchAssist application. For detailed instructions, refer to the article, Registering your application with Zendesk.

Step 2: Configure the Zendesk connector in SearchAssist

Go to the Connectors page under the Sources tab in SearchAssist application and select Zendesk

The page shows the steps to take for Zendesk configuration. Click Proceed

Enter the following using the details of the OAuth client created in the Zendesk application. 

Field Description
Name Name with which the connector will be referred to in the Zendesk application.
Client ID Client Name as given in the OAuth client configured in the Zendesk application. 
Client Secret Client secret generated after configuring OAuth client in the Zendesk application. 
Host URL URL pointing to the Zendesk account. 

 

Click Connect to complete the setup. Once the set up is complete, SearchAssist will automatically synchronize with the Zendesk content and make it available for search. 

Zendesk Connector

You can easily configure SearchAssist to connect to the Zendesk application to enable users to fetch query results using the data and information available in Zendesk.

Specifications

Type of Repository  Cloud
Supported API version REST API v2
Search Results Support Zendesk knowledge base articles
Extractive Model for Answers Zendesk knowledge base articles
Generative Model for Answers Zendesk knowledge base articles

 

To configure Zendesk as a content source, it requires:

  • Configuring an OAuth application in Zendesk
  • Configuring the Zendesk connector in SearchAssist

Step 1: Setup an OAuth client in Zendesk

You need to add an OAuth client in the Zendesk application to generate OAuth credentials that SearchAssist will use to authenticate the requests sent to Zendesk. To do so, log in to the Zendesk application and go to the Admin Center.

Under Apps and Integration, select Zendesk API to build a custom integration with SearchAssist.  Add a new OAuth Client. 

Enter the details required for the client like name, description, company, etc. Set the Redirect URLs field to point to your SearchAssist instance. You can use one of the following callback URLs as per your region.

On saving the details, a pre-populated Secret field will appear on the lower side. This is the client secret specified in the OAuth2 spec. The client name along with the secret generated is required for configuration in the  SearchAssist application. For detailed instructions, refer to the article, Registering your application with Zendesk.

Step 2: Configure the Zendesk connector in SearchAssist

Go to the Connectors page under the Sources tab in SearchAssist application and select Zendesk

The page shows the steps to take for Zendesk configuration. Click Proceed

Enter the following using the details of the OAuth client created in the Zendesk application. 

Field Description
Name Name with which the connector will be referred to in the Zendesk application.
Client ID Client Name as given in the OAuth client configured in the Zendesk application. 
Client Secret Client secret generated after configuring OAuth client in the Zendesk application. 
Host URL URL pointing to the Zendesk account. 

 

Click Connect to complete the setup. Once the set up is complete, SearchAssist will automatically synchronize with the Zendesk content and make it available for search.