Zendesk Chat ON THIS PAGE
Zendesk Chat is a live chat software platform that allows businesses to provide real-time customer support directly on their website or app.
Zendesk Support integration replicates data using the Zendesk Support API .
See the
Schema section for a list of objects available for replication.
Feature snapshot
A high-level look at this connector, including useful links, and supported features.
Preparing for authentication To access your data, you need to authenticate the connection with your account credentials.
Information note Make sure that the account you use has read access to the tables you want to fetch.
To generate your client ID and secret:
Log into your Zendesk chat domain, for example: https://my-sub-domain.zendesk.com/chat. Expand the Settings menu on the left of the page and click Account . Select the API and SDKs tab at the top of the page. Select or add an API Client . Your client ID is displayed on the page. Copy and save the client secret in a secured file. You will need it to connect to the application.
Creating the connection For more information, see Connecting to SaaS applications
Click Authenticate when you have filled in the required connection settings.
You may be asked to log in to the source application.
A window is displayed with an authentication code.
Copy the code to the clipboard and return to the connection dialog.
Paste the code in Complete authentication with the code provided by the source and click Verify .
Tip note You may need to scroll down to see this field.
When status is Verified , the authentication is verified.
Provide a name for the connection in Connection name .
Select Open connection metadata to define metadata for the connection when it has been created.
Connection settings Setting Description Data gateway
Select a Data Movement gateway if required by your use case.
Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway . If you have another subscription tier and do not want to use Data Movement gateway , select None .
For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement
Start Date Enter the date, in the format MM/DD/YYYY, from which the data must be replicated from your source to your target.
Zendesk Subdomain The subdomain of your Zendesk site. For example, the subdomain of qlik.zendesk.com would be qlik. Client ID Client ID. Client Secret Client secret.
Information note Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.
The schema and info displayed below is for version 1.
Depending on your destination, table and column names may not appear as they are outlined below.
account
The account table contains info about accounts within your Zendesk Chat account.
account table foreign keys Join account with on goals account.plan.goals = goals.id chats account.plan.goals = chats.conversions.goal_id account.plan.goals = chats.history.conversion.goal_id
account table schema
account_key
STRING
billing
OBJECT
This is a nested data structure:
additional_info: STRING address1: STRING address2: STRING city: STRING company: STRING country_code: STRING email: STRING first_name: STRING last_name: STRING postal_code: STRING state: STRING
create_date
DATE-TIME
plan
OBJECT
This is a nested data structure:
agent_leaderboard: BOOLEAN agent_reports: BOOLEAN analytics: BOOLEAN chat_reports: BOOLEAN daily_reports: BOOLEAN email_reports: BOOLEAN file_upload: BOOLEAN goals: INTEGER high_load: BOOLEAN integrations: BOOLEAN ip_restriction: BOOLEAN long_desc: STRING max_advanced_triggers: STRING max_agents: INTEGER max_basic_triggers: STRING max_concurrent_chats: STRING max_departments: STRING max_history_search_days: STRING monitoring: BOOLEAN name: STRING operating_hours: BOOLEAN price: NUMBER rest_api: BOOLEAN short_desc: STRING sla: BOOLEAN support: BOOLEAN unbranding: BOOLEAN widget_customization: STRING
status
STRING
agents
The agents table contains info about agents within your Zendesk Chat account.
agents table foreign keys Join agents with on chats agents.id = chats.agent_ids agents.departments = chats.department_id agents.departments = chats.history.prev_department_id departments agents.departments = departments.id shortcuts agents.departments = shortcuts.departments
agents table schema
create_date
DATE-TIME
departments
ARRAY
display_name
STRING
email
STRING
enabled
BOOLEAN
enabled_departments
ARRAY
first_name
STRING
id
INTEGER
last_login
DATE-TIME
last_name
STRING
login_count
INTEGER
role_id
INTEGER
roles
OBJECT
This is a nested data structure:
administrator: BOOLEAN owner: BOOLEAN
scope
STRING
skills
ARRAY
bans
The bans table contains info about bans created in your Zendesk Chat account.
bans table schema
created_at
DATE-TIME
id
INTEGER
ip_address
STRING
reason
STRING
type
STRING
visitor_id
STRING
visitor_name
STRING
chats
The chats table contains info about the chats within your Zendesk Chat account.
chats table foreign keys Join chats with on agents chats.agent_ids = agents.id chats.department_id = agents.departments chats.history.prev_department_id = agents.departments departments chats.department_id = departments.id chats.history.prev_department_id = departments.id shortcuts chats.department_id = shortcuts.departments chats.history.prev_department_id = shortcuts.departments goals chats.conversions.goal_id = goals.id chats.history.conversion.goal_id = goals.id account chats.conversions.goal_id = account.plan.goals chats.history.conversion.goal_id = account.plan.goals
chats table schema
agent_ids
ARRAY
agent_names
ARRAY
comment
STRING
conversions
ARRAY
This is a nested data structure:
attribution: OBJECT, which is also a nested data structure.
agent_id: INTEGER agent_name: STRING chat_timestamp: DATE-TIME department_id: INTEGER department_name: STRING goal_id: INTEGER goal_name: STRING id: STRING timestamp: DATE-TIME
count
OBJECT
This is a nested data structure:
agent: INTEGER total: INTEGER visitor: INTEGER
department_id
INTEGER
department_name
STRING
duration
INTEGER
end_timestamp
DATE-TIME
history
ARRAY
This is a nested data structure:
channel: STRING conversion: OBJECT, which is also a nested data structure.
attribution: OBJECT, which is also a nested data structure.
agent_id: INTEGER agent_name: STRING chat_timestamp: DATE-TIME department_id: INTEGER department_name: STRING goal_id: INTEGER goal_name: STRING id: STRING timestamp: DATE-TIME department_id: INTEGER, STRING department_name: STRING msg: STRING msg_id: STRING, INTEGER name: STRING new_rating: STRING new_tags: ARRAY nick: STRING options: STRING prev_department_id: INTEGER, STRING rating: STRING skills_name: ARRAY tags: ARRAY timestamp: DATE-TIME type: STRING
id
STRING
message
STRING
missed
BOOLEAN
rating
STRING
referrer_search_engine
STRING
referrer_search_terms
STRING
response_time
OBJECT
This is a nested data structure:
avg: NUMBER, INTEGER first: INTEGER max: INTEGER
session
OBJECT
started_by
STRING
tags
ARRAY
timestamp
DATE-TIME
triggered
BOOLEAN
triggered_response
BOOLEAN
type
STRING
unread
BOOLEAN, INTEGER
visitor
OBJECT
This is a nested data structure:
email: STRING id: STRING name: STRING notes: STRING phone: STRING
webpath
ARRAY
zendesk_ticket_id
INTEGER
departments
The departments table contains info about departments within your Zendesk Chat account.
departments table foreign keys Join departments with on shortcuts departments.id = shortcuts.departments chats departments.id = chats.department_id departments.id = chats.history.prev_department_id agents departments.id = agents.departments
departments table schema
description
STRING
enabled
BOOLEAN
id
INTEGER
members
ARRAY
name
STRING
settings
OBJECT
goals
The goals table contains info about URL-based goals set within your Zendesk Chat account.
goals table foreign keys Join goals with on chats goals.id = chats.conversions.goal_id goals.id = chats.history.conversion.goal_id account goals.id = account.plan.goals
goals table schema
attribution_model
STRING
attribution_period
INTEGER
description
STRING
enabled
BOOLEAN
id
INTEGER
name
STRING
settings
OBJECT
This is a nested data structure:
conditions: ARRAY, which is also a nested data structure.
operator: STRING type: STRING value: STRING
shortcuts
The shortcuts table contains info about shortcuts within your Zendesk Chat account.
shortcuts table foreign keys Join shortcuts with on departments shortcuts.departments = departments.id chats shortcuts.departments = chats.department_id shortcuts.departments = chats.history.prev_department_id agents shortcuts.departments = agents.departments
shortcuts table schema
agents
ARRAY
departments
ARRAY
id
STRING
message
STRING
name
STRING
options
STRING
scope
STRING
tags
ARRAY
triggers
The triggers table contains info about triggers within your Zendesk Chat account.
triggers table schema
definition
OBJECT
This is a nested data structure:
actions: STRING condition: STRING event: STRING version: INTEGER
description
STRING
enabled
BOOLEAN
id
INTEGER
name
STRING
