Перейти к основному содержимому Перейти к дополнительному содержимому

Zendesk Support 

Zendesk Support provides SaaS products related to customer support, sales, and other customer communications. You can use Zendesk Support as a data source when landing or replicating data.

Zendesk Support integration replicates data using the Zendesk Support API.

See the Schema section for a list of objects available for replication.

Preparing for authentication

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

Примечание к информацииУбедитесь, что используемая учетная запись имеет доступ для чтения к таблицам, которые требуется получить.

To set up the integration, you must have administrator permissions in Zendesk. Replicating SLA policies requires an Enterprise or Professional plan.

Creating the connection

For more information, see Подключение к приложениям SaaS.

  1. 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.

  2. Copy the code to the clipboard and return to the connection dialog.

  3. Paste the code in Complete authentication with the code provided by the source and click Verify.

    Примечание к подсказкеYou may need to scroll down to see this field.

    When status is Verified, the authentication is verified.

  4. Provide a name for the connection in Connection name.

  5. Select Open connection metadata to define metadata for the connection when it has been created.

Connection settings
SettingDescription
Data gateway

Выберите шлюз Шлюз движения данных, если этого требует текущий сценарий использования.

Примечание к информации

Это поле недоступно при использовании подписки Qlik Talend Cloud Starter, так как она не поддерживает Шлюз движения данных. Если используется другой уровень подписки или не требуется использовать Шлюз движения данных, выберите Нет.

Для получения информации о преимуществах Шлюз движения данных и о сценариях, требующих его использования, см. раздел Шлюз данных Qlik — движение данных.

Start DateEnter the date, in the format MM/DD/YYYY, from which the data must be replicated from your source to your target.
Zendesk Subdomain

You can find the subdomain of your Zendesk site in the URL of your account homepage. If the URL is https://qlik.zendesk.com/, the subdomain is qlik.

Client IDClient ID.
Client SecretClient secret.
Marketplace NameName of the integration.
Marketplace Organization IDOrganization ID.
Marketplace App IDApp ID.

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 2.

Depending on your destination, table and column names may not appear as they are outlined below.

group_memberships

The group_memberships table contains info about the groups your Zendesk Support agents are members of.

Note: Retrieving group membership data requires Zendesk Support Agent or Admin permissions.

Deleted group memberships

As Zendesk Support’s API doesn’t currently provide a method for identifying deleted group memberships, we recommend periodically dropping this table and allowing Stitch to re-create it. Currently, dropping and re-populating the table is the only way to detect deletions.

Replication Method

CDC

Primary Key

id

Replication Key

updated_at

Useful links

Zendesk Support documentation

Zendesk Support API method

groups

The groups table contains info about the groups in your Zendesk Support account.

Note: Retrieving group data requires Zendesk Support Admin or Agent permissions.

Replication Method

CDC

Primary Key

id

Replication Key

updated_at

Useful links

Zendesk Support documentation

Zendesk Support API method

macros

The macros table contains info about the macros in your Zendesk Support account. Macros are actions defined by you that modify the values of a ticket’s fields.

Note: Retrieving macro data requires Zendesk Support Agent or Admin permissions.

Replication Method

CDC

Primary Key

id

Replication Key

updated_at

Useful links

Zendesk Support documentation

Zendesk Support API method

organizations

The organizations table contains information about the organizations your end-users belong to.

Custom organization fields

Zendesk Support integration will replicate any custom fields associated with organization records.

Note: Replicating organization custom fields requires that you be on a Team, Professional, or Enterprise Zendesk Support plan and have Admin permissions in Zendesk Support.

Replication Method

CDC

Primary Key

id

Replication Key

updated_at

Useful links

Zendesk Support documentation

Zendesk Support API method

satisfaction_ratings

The satisfaction_ratings table contains info about ratings users have offered on support tickets.

Note: This table is only available if satisfaction ratings are enabled in your Zendesk Support account.

Replication Method

CDC

Primary Key

id

Replication Key

updated_at

Useful links

Zendesk Support documentation

Zendesk Support API method

sla_policies

The sla_policies table contains info about the Service Level Agreements (SLAs) in your Zendesk Support account. An SLA is a documented agreement between a support provider and their customers that defines performance measures for support.

Note: Replicating SLA policies requires that you be on an Enterprise or Professional Zendesk Support plan, and have Admin permissions in Zendesk Support.

Replication Method

Full Table

Primary Key

id

Useful links

Zendesk Support documentation

Zendesk Support API method

tags

The tags table the names and total number of applications of the tags in your Zendesk Support account.

Note: Retrieving tag data requires Zendesk Support Admin permissions.

Replication Method

Full Table

Primary Key

name

Useful links

Zendesk Support documentation

Zendesk Support API method

talk_phone_numbers

This table contains data about phone numbers in Zendesk Talk.

Replication Method

Full Table

Primary Key

id

Useful links

Zendesk Support API method

ticket_audits

The ticket_audits table contains info about the activity associated with a ticket. An audit is a history of all updates to a given ticket. When a ticket is updated in Zendesk Support, an audit record is created. Each audit represents a single update to a ticket.

A single audit record may include multiple event types. For example: A ticket comment, satisfaction rating, and a change event. For a full list of Zendesk Support audit event types, refer to Zendesk Support’s documentation.

Replication

This table uses Append-Only Incremental Replication. This means that new audit records, or updates made to existing audits, are appended as new rows to the end of the table.

Replication Method

Append-Only Incremental

Primary Key

id

Replication Key

created_at

Useful links

Zendesk Support documentation

Zendesk Support API method

ticket_comments

The ticket_comments table contains info about the comments on tickets, which is the conversation between requesters, collaborators, and agents. Comments can be public or private.

Replication Method

CDC

Primary Key

id

Replication Key

created_at

Useful links

Zendesk Support documentation

Zendesk Support API method

ticket_fields

The ticket_fields table contains info about the basic text and custom ticket fields in your Zendesk Support account.

Note: Retrieving ticket metric data requires Zendesk Support Agent or Admin permissions.

Replication Method

CDC

Primary Key

id

Replication Key

updated_at

Useful links

Zendesk Support documentation

Zendesk Support API method

ticket_forms

The ticket_forms table contains info about the ticket forms in your Zendesk Support account.

Note: Replicating ticket forms requires that you be on an Enterprise Zendesk Support plan or a Professional plan with the corresponding add-on, and have Admin permissions in Zendesk Support.

Replication Method

CDC

Primary Key

id

Replication Key

updated_at

Useful links

Zendesk Support documentation

Zendesk Support API method

ticket_metric_events

This table contains data about reply times, agent work times, and requester wait times.

Replication Method

CDC

Primary Key

id

Replication Key

time

Useful links

Zendesk Support API method

ticket_metrics

The ticket_metrics table contains info about the metrics associated with Zendesk Support tickets. This table will not include records for deleted tickets.

Note: Retrieving ticket metric data requires Zendesk Support Admin permissions.

Deleted ticket metrics

As Zendesk Support’s API doesn’t currently support returning metrics for deleted tickets, this table will not contain any metrics for deleted tickets.

If you believe you’re missing records, check in your Zendesk Support account to see if the missing records are for deleted tickets.

For more info on how Zendesk Support handles deleting tickets, refer to their documentation.

Replication Method

CDC

Primary Key

id

Replication Key

updated_at

Useful links

Zendesk Support documentation

Zendesk Support API method

tickets

The tickets table contains info about the tickets in your Zendesk Support account. Tickets are the means through which your end users (customers) communicate with your Zendesk Support agents.

Note: Retrieving ticket data requires Zendesk Support Admin permissions.

Custom ticket fields

Zendesk Support integration will replicate all custom ticket fields.

Replication Method

CDC

Primary Key

id

Replication Key

generated_timestamp

Useful links

Zendesk Support documentation

Zendesk Support API method

users

The users table contains info about the users associated with your Zendesk Support account. This includes agents, admins, and end-users (customers).

Note: Retrieving user data requires Zendesk Support Admin permissions.

Custom user fields

Zendesk Support integration will replicate any custom fields associated with user records.

Note: Replicating user custom fields requires that you be on a Team, Professional, or Enterprise Zendesk Support plan.

Replication Method

CDC

Primary Key

id

Replication Key

updated_at

Useful links

Zendesk Support documentation

Zendesk Support API method

Помогла ли вам эта страница?

Если вы обнаружили какую-либо проблему на этой странице или с ее содержанием — будь то опечатка, пропущенный шаг или техническая ошибка, сообщите нам об этом!