Zendesk is cloud-based customer relationship management and customer support platform that provides tools for tracking, prioritizing, and solving customer support tickets. The Zendesk connector provided with Workplace Search automatically captures, syncs and indexes the following items:
ID, ticket content, tags, status, priority, user data and timestamps
Configuring the Zendesk Connectoredit
Configuring the Zendesk connector is the first step prior to connecting the Zendesk service to Workplace Search, and requires that you create an OAuth App from the Zendesk platform. To get started, first log in to Zendesk and access your administrative dashboard:
Step 1. Locate the Zendesk Admin interface (gear icon in the sidebar). Select API under Channels:
Step 2. Make sure to agree to the Terms of Service. Navigate over to the OAuth Clients tab and click the + button on the right-hand side:
Step 3. Time to fill out some information:
- Client Name: You’ll use this to identify the OAuth application.
- Description: Also used for identification, use at your own discretion.
- Company: Elastic makes Workplace Search. You can use that, or your own – whatever works.
- Logo: Optional, will be displayed during the Connection process.
elastic_enterprise_search– this is required and must be as is.
Redirect URLs: The following two URLs, substituting
<WS_BASE_URL>with the base URL at which Workplace Search is hosted (scheme + host, no path).
# Deployment using a custom domain name https://www.example.com/ws/org/sources/zendesk/create https://www.example.com/ws/sources/zendesk/create # Deployment using a default Elastic Cloud domain name https://c3397e558e404195a982cb68e84fbb42.ent-search.us-east-1.aws.found.io/ws/org/sources/zendesk/create https://c3397e558e404195a982cb68e84fbb42.ent-search.us-east-1.aws.found.io/ws/sources/zendesk/create # Unsecured local development environment http://localhost:3002/ws/org/sources/zendesk/create http://localhost:3002/ws/sources/zendesk/create
Step 4. Upon saving, a secret token will be generated. Keep it safe and handy, as we’ll require it in just a few moments.
Step 5. From the Workplace Search administrative dashboard’s Sources area, locate Zendesk and provide both the Client ID (
elastic_enterprise_search) and the Client Secret (the secret token previously generated). Voilà! The Zendesk connector is now configured, and ready to be used to synchronize content. In order to capture data, you must now connect a Zendesk instance with the adequate authentication credentials.
Connecting Zendesk to Workplace Searchedit
Once the Zendesk connector has been configured, you may connect a Zendesk instance to your organization.
Step 1. Head to your organization’s Workplace Search administrative dashboard, and locate the Sources tab.
Step 2. Click Add a new source.
Step 3. Select Zendesk in the Configured Sources list, and follow the Zendesk authentication flow as presented.
Step 4. Upon the successful authentication flow, you will be redirected to Workplace Search, and your organization’s Zendesk content will now be captured and will be ready for search gradually as it is synced. Once successfully configured and connected, the Zendesk synchronization automatically occurs every 2 hours.