Zendesk Chat
Guide to integrate your Zendesk Chat 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 Chat
Provide all the mandatory details
Name: Name to identify this connection
Sub Domain: Only Give {SUBDOMAIN}. For ex:- https://{SUBDOMAIN}.zendesk.com
Advance Settings: Refer here
Connect to Zendesk Chat: Sprinkle will ask the permission to read the data. Allow it.
Test Connection
Create
STEP-2: Configure Pipeline
To learn about Pipeline, refer here
Navigate to Ingest -> Pipeline Tab -> Add ->
Select Zendesk Chat
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.
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 Settings
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 Chat API being used.
Dataset Fields
Agents
last_name
email
skills
enabled
departments
create_date
display_name
id
first_name
enabled_departments
role_id
last_login
login_count
roles_administrator
roles_owner
Accounts
account_key
create_date
status
plan_goals
plan_long_desc
plan_price
plan_short_desc
plan_widget_customization
plan_max_agents
plan_sla
plan_monitoring
plan_rest_api
plan_email_reports
plan_daily_reports
plan_chat_reports
plan_agent_reports
plan_agent_leaderboard
plan_unbranding
plan_high_load
plan_ip_restriction
plan_support
plan_name
plan_max_basic_triggers
plan_max_advanced_triggers
plan_max_departments
plan_max_concurrent_chats
plan_max_history_search_days
plan_operating_hours
plan_file_upload
plan_analytics
plan_integrations
Trigger
definition_actions_0__0_
definition_actions_0__1_
definition_actions_1__0_
definition_actions_1__1_
definition_actions_1__2_
definition_event
definition_condition_0_
definition_condition_1__0_
definition_condition_1__1__0_
definition_condition_2__0_
definition_condition_2__1__0_
definition_condition_2__1__1_
definition_condition_2__1__2_
definition_condition_2__2__0_
definition_condition_2__2__1_
definition_condition_2__3__0_
definition_condition_2__3__1_
definition_condition_2__3__2_
enabled
name
id
description
definition_version
definition_condition_1__1_
definition_condition_1__2_
definition_condition_2__1_
definition_condition_3__0_
definition_condition_3__1_
definition_condition_3__2_
definition_condition_4__0_
definition_condition_4__1_
definition_condition_4__2_
definition_condition_5__0_
definition_condition_5__1__0_
definition_actions_0__2_
definition_condition_2__2_
definition_condition_3__1__0_
Roles
name
permissions_visitors_seen
permissions_proactive_chatting
permissions_edit_visitor_information
permissions_edit_visitor_notes
permissions_view_past_chats
permissions_edit_chat_tags
permissions_manage_bans
permissions_access_analytics
permissions_view_monitor
permissions_edit_department_agents
permissions_set_agent_chat_limit
permissions_manage_shortcuts
enabled
description
id
members_count
Last updated