Zendesk Chat

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.

对这个连接器进行高级查看，包括有用的链接和支持的特性。

特性/功能	支持详情
支持的 Qlik Talend Data Integration 项目	仅 Replication 项目。不支持数据管道项目。
目标更新方法	复制任务：应用更改存储更改在数据湖任务中登陆数据：更改数据捕获 (CDC)
管理元数据	无需手动生成元数据。
模式演变	只支持更改列数据类型操作。
复制 LOB 列（NCLOB、CLOB 和 BLOB）	不支持
已计划 CDC	必填字段。这就是目标与源的更改保持同步的方式。有关复制任务，请参阅计划任务有关湖登陆任务，请参阅为湖登陆任务调度 CDC
通知	部分支持设置操作更改通知
监视	仅 CDC，因为满负载与此连接器无关。监视单个数据任务
JSON 列有效载荷的自动解密	不支持不会自动在目标上删除源数据集中的 JSON 列有效负载。

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

请确保您使用的帐户对要获取的表具有读取权限。

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

有关更多信息，请参阅连接到 SaaS 应用程序。

填写完所需的连接设置后，单击身份验证。
您可能会被要求登录源应用程序。
将显示一个带有身份验证代码的窗口。
将代码复制到剪贴板，然后返回到连接对话框。
粘贴使用源提供的代码完成身份验证中的代码，然后单击验证。
提示注释您可能需要向下滚动才能查看此字段。
在状态为已验证时，身份验证即得到验证。
在连接名称中提供连接的名称。
选择打开连接元数据以定义创建连接时的元数据。

Connection settings
Setting	Description
Data gateway	如果您的用例需要，请选择一个数据移动网关。信息注释此字段不适用于 Qlik Talend Cloud Starter 订阅，因为它不支持数据移动网关。如果您有另一个订阅层并且不想使用数据移动网关，请选择无。有关数据移动网关的优势和需要它的用例的信息，请参阅Qlik 数据网关 - 数据移动。
Start Date	按格式 `MM/DD/YYYY` 输入必须将数据从源复制到目标的日期。
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.

Schema

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.

Replication Method

Full Table

Primary Key

account_key

Useful links

Zendesk Chat API method

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

Join account with

goals

account.plan.goals = goals.id

chats

account.plan.goals = chats.conversions.goal_id

account.plan.goals = chats.history.conversion.goal_id

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.

Replication Method

Full Table

Primary Key

Useful links

Zendesk Chat API method

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

Join agents with

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

create_date

DATE-TIME

departments

ARRAY

display_name

STRING

email

STRING

enabled

BOOLEAN

enabled_departments

ARRAY

first_name

STRING

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.

Replication Method

Full Table

Primary Key

Useful links

Zendesk Chat API method

created_at

DATE-TIME

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.

Replication Method	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Zendesk Chat API method

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

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

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.

Replication Method

Full Table

Primary Key

Useful links

Zendesk Chat API method

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

Join departments with

shortcuts

departments.id = shortcuts.departments

chats

departments.id = chats.department_id

departments.id = chats.history.prev_department_id

agents

departments.id = agents.departments

description

STRING

enabled

BOOLEAN

INTEGER

members

ARRAY

name

STRING

settings

OBJECT

goals

The goals table contains info about URL-based goals set within your Zendesk Chat account.

Replication Method

Full Table

Useful links

Zendesk Chat API method

Join goals with	on
chats	goals.id = chats.conversions.goal_id goals.id = chats.history.conversion.goal_id
account	goals.id = account.plan.goals

Join goals with

chats

goals.id = chats.conversions.goal_id

goals.id = chats.history.conversion.goal_id

account

goals.id = account.plan.goals

attribution_model

STRING

attribution_period

INTEGER

description

STRING

enabled

BOOLEAN

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.

Replication Method

Full Table

Primary Key

name

Useful links

Zendesk Chat API method

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

Join shortcuts with

departments

shortcuts.departments = departments.id

chats

shortcuts.departments = chats.department_id

shortcuts.departments = chats.history.prev_department_id

agents

shortcuts.departments = agents.departments

agents

ARRAY

departments

ARRAY

STRING

message

STRING

name

STRING

options

STRING

scope

STRING

tags

ARRAY

triggers

The triggers table contains info about triggers within your Zendesk Chat account.

Replication Method

Full Table

Primary Key

Useful links

Zendesk Chat API method

definition

OBJECT

This is a nested data structure:

actions: STRING
condition: STRING
event: STRING
version: INTEGER

description

STRING

enabled

BOOLEAN

INTEGER

name

STRING

本页面有帮助吗？

如果您发现此页面或其内容有任何问题 – 打字错误、遗漏步骤或技术错误 – 请告诉我们！

在此处留下您的反馈