Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Go to Haptik Website
  • Contact Us
  • Home
  • Developer Guides
  • Zendesk Guide Integration

How to Set Up Zendesk Guide Integration on Haptik bot

Written by Soham Amburle

Updated on April 19th, 2023

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Getting Started
    Build Deploy Analyse Manage Account Bot Deactivation
  • Bot Building
    Essentials Smart Skills Steps User Messages Bot Responses Entities Connections Customisations User feedback collection Testing Whatsapp Bots NLU Bot Maintenance
  • Smart Agent Chat
    Set up Admin Settings MyChats Section (Agent Inbox) Live Traffic Section Teams Section Archives Section Analytics Plans on Smart Agent Chat
  • Conversation Design
    Design Basics Design Guides Designing for Platforms Designing WhatsApp Bots
  • Developer Guides
    Code Step Integration Static Step Integration Shopify Integration SETU Integration Exotel Integration CIBIL integration Freshdesk KMS Integration PayU Integration Zendesk Guide Integration Twilio Integration Razorpay Integration LeadSquared Integration USU(Unymira) Integration Helo(VivaConnect) Integration Salesforce KMS Integration Stripe Integration PayPal Integration CleverTap Integration Fynd Integration HubSpot Integration Magento Integration WooCommerce Integration Microsoft Dynamics 365 Integration
  • Deployment
    Web SDK WhatsApp Facebook Instagram Sunshine Conversation LINE Google Business Messages Telegram MS Teams Bot as an API iOS SDK Android SDK
  • External Agent Tool Setup
    Zendesk Chat Salesforce Service Cloud Freshchat Zoho NICE CXOne Gorgias
  • Analytics & Reporting
    Intelligent Analytics
  • Notifications
    SMS Notifications Success Measurement
  • Commerce Plus
    Catalog Integration Bot Building Guide Channel Deployments Unified ML Pipeline Documentation
  • Troubleshooting Guides
    Error Messages FAQs
  • Release Notes
+ More

Table of Contents

Zendesk GuidePrerequisites for integrating Zendesk Guide with HaptikHow to set up?

Zendesk Guide

Let us first understand what Zendesk Guide is. It is a tool that is used by businesses to help organize their documentation, or in other words Knowledge Base, which includes documents related to their business-specific use cases, as well as the frequently asked questions, and other information. These documents are stored in easily accessible formats for both internal as well as external users.

Zendesk is a customer support software that allows you to create a Guide. The guide enables you to provide end-users with a complete self-service support option and empowers agents to better help customers. Using Zendesk Guide you can create a help center that includes,

  • Branded customer-facing support site.
  • Knowledge base, for publishing self-service content.
  • Community, for customer collaboration (available on Suite Professional and above; not available for Support + Guide customers)
  • Customer portal, where customers submit tickets and also manage their tickets (ticket management is not available on Suite Team)

You can read more about Zendesk Guide, here.

Once this integration is enabled, every time a user asks a query on your bot, the bot will respond by suggesting relevant articles from your Zendesk Guide, after understanding the intent of the query. We will understand this in detail, in the further sections of this article.

Prerequisites for integrating Zendesk Guide with Haptik

  • A paid account on Zendesk. You can check the pricing, here.
  • A knowledge base on Zendesk Guide. You can learn more about creating a knowledge base on Zendesk, here.
  • A bot on Haptik. You can learn more about creating a bot, here.

How to set up?

Once you have all the prerequisites ready with you, all you need to do is integrate your Zendesk Guide with Haptik. For connecting them, you would need to add integration details to the Platform Deployments section on Haptik.

Step 1: Log in to Haptik, open your bot and navigate to Conversation Studio > Business Manager > Channels > Platform Deployments, and select KMS Integration from the Platform dropdown, as shown.


Step 2: Add zendesk in the field KMS Type.


Step 3: Add your bot's name in the field Bot Name. Make sure you have added the name accurately.


Step 4: Turn the Active toggle button on.


Step 5: Under KMS Settings, enter the following JSON as per the instructions.

{  
   "api_key":"<paste your API Token here>",
   "api_url": "https://<domain_name>.zendesk.com/api/v2/help_center/articles",
   "default_thumbnail":"https://haptikappimg.haptikapi.com/kms.png"
}
Delete

Following are the steps for retrieving api_key and api_url from Zendesk.

api_key

  • To acquire the api_key, navigate to your Zendesk account, and click on the Admin Center as shown below. 
  • Next, you need to select Apps and Integrations, and under that select Zendesk API, and click on Add API Token, as shown below. 
  • After clicking Add API Token, a token will be generated. You need to copy and store this token as it will not be available once you click on Save. This API Token is the api_key.

api_url

  • For api_url, navigate to your Zendesk Guide dashboard, and you will get the api_url from the URL. 
  • Here, as shown in the above image, demodomaintest is the domain name that will come at the place of <domain_name> in this URL - 
    "api_url": "https://<domain_name>.zendesk.com/api/v2/help_center/articles",
  • The URL becomes - 
    "api_url": "https://<demodomaintest>.zendesk.com/api/v2/help_center/articles",

default_thumbnail will be the thumbnail URL, that will be used in the carousel when the bot will display the articles.

Once you have the api_key and api_url, update the JSON under KMS Settings as shown.

Step 6: Once you have populated all the fields in the Platform Deployments, with the appropriate details in it, you can Save it.


Step 7: You will have to raise a Support Ticket on the Haptik portal or drop an email at support@haptik.ai, for activating the KMS feature on your bot.  Please mention your bot's name on the ticket. This is a one-time activity, and it will take at the most 1-2 business days for activating this feature. 

Delete

Note:

Haptik syncs articles from your Knowledge Base every 24 hours at midnight, to ensure that the bot is up-to-date with the latest content changes.

Once the KMS integration is activated on your bot, you are good to test your bot and see how it fetches the articles from your knowledge base added to the Zendesk Guide.

Once tested, you can move your bot to the Production Environment, where you can take it LIVE for your users. Congratulations!

Delete

Note:

The bot will suggest Knowledge Base articles in the following order of prioritization

Steps in the bot > FAQs added > Knowledge Management System

What this means is, if a user asks a query to the bot, and if there is a Step present in the bot for handling that query, the bot will fetch the response from that Step. If there is an FAQ added to the bot, then the bot will fetch the response to the user's query from the FAQs. 

If none of the two mentioned above are present, that is when the bot will fetch the response from the Knowledge Management System and will suggest appropriate articles as a response

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Step 2 - How to check the feedback collected on my bot?
  • What is Words and Phrases Entity?
  • Which all languages are supported on Haptik bots?
  • What are Video HSLs?
  • What are WhatsApp Voice Notes?

Platform

  • Conversation Studio
  • Smart Skills
  • Advanced NLU
  • Intelligent Analytics
  • Omnichannel
  • Smart Agent Chat
  • Enterprise Security
  • Integrations

Solutions

  • Conversational Commerce
  • Lead Generation
  • Customer Care
  • WhatsApp
  • Conversational IVR
  • Google Business Messages

Industries

  • Retail/ E-Commerce
  • Financial Services
  • Travel & Hospitality
  • Telecom

Knowledge

  • ROI Calculator
  • Reports & Research
  • Case Studies
  • Webinars
  • ISAT
  • Tech Blog
  • Business Blog
  • Resources
  • Haptik v/s Yellow
  • Haptik v/s Liveperson
  • Haptik v/s IBM Watson
  • Haptik v/s Verloop
  • Conversations on AI

Company

  • Why Haptik
  • About Us
  • Careers
  • News & Media
  • Awards & Recognition
  • Contact Us
  • Partnerships
  • Investor Relations

Subscribe

Sign up to recieve the latest updates

Find us on

  • Twitter-footer
  • Linkedin-footer
  • YT-footer
  • Insta-footer
  • G2-footer
  • Facebook-footer

Knowledge Base Software powered by Helpjuice

Copyright © jio Haptik Technology Limited 2021 | Data Security & Privacy Policy | GDPR

North America | Asia Pacific | Africa | enterprise@haptik.ai

Definition by Author

0
0