Zendesk Support
Guide to integrate your Zendesk Support with Sprinkle
Pipeline Concepts
Before setting up the Pipeline, learn about Pipeline concepts here
Step by Step Guide
STEP-1: Configure Connection
To learn about Connection, refer here
Log into Sprinkle application
Navigate to Ingest -> Connections Tab -> New Connection ->
Select Zendesk Support
Provide all the mandatory details
Name: Name to identify this connection
Sub Domain: Only Give {SUBDOMAIN}. For ex:- https://{SUBDOMAIN}.zendesk.com
Email Id: Give Email ID connected to your zendesk account
API Token: API token for zendesk account. (Refer the link to generate API Token - https://support.zendesk.com/hc/en-us/articles/4408889192858-Generating-a-new-API-token )
Advance Settings: Refer here
Test Connection
Create
STEP-2: Configure Pipeline
To learn about Pipeline, refer here
Navigate to Ingest -> Pipeline Tab -> Add ->
Select Zendesk Support
Provide the name -> Create
Connection Tab:
From the drop-down, select the name of connection created in STEP-2
Update
STEP-3: Create Dataset
Datasets Tab: To learn about Dataset, refer here. Add Dataset for each report/dataset that you want to integrate, providing following details
Report Type (Required): Select from the drop-down:
Groups
Group_Memberships
Organizations
Organization_Memberships
Satisfaction_Ratings
Macros
Tickets
Suspended_Tickets
Ticket_Metrics
Ticket_Fields
Target_Failures
Tags
Brands
Views
Triggers
Automations
Targets
Apps
Sharing_Agreements
Flatten Level(Required) : Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi level, flattening will be applied in complex level till they become simple type.
Destination Schema (Required) : Data warehouse schema where the table will be ingested into
Destination Table name (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds_<Pipelinename>_<tablename>
Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. Learn more on how to use this field.
Create
STEP-4: Run and schedule Ingestion
In the Ingestion Jobs tab:
Trigger the Job, using Run button
To schedule, enable Auto-Run. Change the frequency if needed
Advanced Connection Setting
API Read Timeout (In seconds) : Maximum time of inactivity between two data packets when waiting for the server's response. The default value is 30 seconds
API Connection Timeout (In seconds) : Time period within which a connection between a client and a server must be established.
Retry Limit : Number of retries allowed when an API call fails. For example if an API call fails and retry limit is 5 then it will check 5 times for that API call and if it succeeded then it will stop checking.
Retry Sleep Time (In milliseconds) : Given time, after which retry should happen in case an API call fails.
API Delay Time (In milliseconds) : The time difference (in milliseconds) between two successive API calls.
Version : it gives information about the version of Zendesk Support API being used.
Dataset Fields
Last updated