Hevo lets you load your Zendesk tickets and user information into your data warehouse. This document lists the steps to integrate your Zendesk source with Hevo.
You must be an admin in Zendesk to access your data through APIs.
Generate a Zendesk API token
Go to your Zendesk dashboard, on the left navigation bar you will find a gear() icon. Upon clicking, you will enter a new page. Select Channels > API here. Click on the settings tab and enable Token Access. Click on the + button and generate a new API Token. Copy the API Token and save it in a secure location. For more details please go through this Zendesk documentation.
Creating a Pipeline with Zendesk as a source
1. Create Pipeline
On your Hevo dashboard. Click on PIPELINES option in the left navigation bar and click on Create Pipeline.
2. Select Source Type
Select Zendesk from the list on Select Source Type screen.
3. Enter details for connecting to Zendesk
Add your Zendesk details in the next screen. Note that you will need to have an admin role on Zendesk to access Zendesk data. You will need to enter the following details.
- Source Name: A unique name for your Zendesk source
- Sub Domain: Your Zendesk Sub Domain
- Email: Your login email id for Zendesk
- Token: Zendesk token which you created in the first step
Click on the Test Connection to validate the details you have entered once everything looks good, hit continue.
4. Select the Destination
Select the Destination where you want to load Zendesk data to or click on NEW DESTINATION to create a new Destination. Check out How to add a Destination document for the detailed walkthrough on steps needed to add a new Destination.
5. Pipeline Created
Your Pipeline will be created when you enter this page. You will now have an option to see Sample Data and Map Schema.
While Hevo tries to load your data, you can select CONTINUE IN BACKGROUND if it is taking too long. Click on CREATE SCHEMA MAPPING to map Source and Destination Schemas, check out Introduction to Schema Mapper to learn about Schema Mapper or you can select DO IT LATER to directly head to the Pipeline page. You can map the schemas later on the Schema Mapper page in your pipeline.
Please note that your data will not start replicating in Destination tables until you map the source and Destination schemas.
How it works
Hevo gets information regarding your Tickets, Ticket Events, Organizations and Users using Zendesks Incremental Export API. The data produced by these APIs have a field named id that is unique to a datatype(e.g. ticket or user). Hevo recommends you to use id as your primary key while creating a table in your destination.