# Zendesk Chat (v1) Information note **Zendesk Chat extraction is supported by Stitch** This integration is powered by [Singer's](https://www.singer.io/) Zendesk Chat tap and certified by Stitch. [Check out and contribute to the repo on GitHub](https://github.com/singer-io/tap-zendesk-chat). For support, contact [Support](https://community.qlik.com/t5/Support/ct-p/qlikSupport). ## Zendesk Chat integration summary Stitch’s Zendesk Chat integration replicates data using the [Zendesk Chat API](https://developer.zendesk.com/api-reference/live-chat/introduction). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#schema) section for a list of objects available for replication. ## Zendesk Chat feature snapshot A high-level look at Stitch's Zendesk Chat (v1) integration, including release status, useful links, and the features supported in Stitch. | **STITCH** | | | | | --- | --- | --- | --- | | **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on November 15, 2022 | **Supported by**

the Info icon

Indicates if the integration is supported by Stitch or the Singer community. | [Stitch](https://community.qlik.com/t5/Support/ct-p/qlikSupport) | | **Stitch plan**

the Info icon

The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**

the Info icon

Indicates if the integration is available as a source in Stitch Connect. | the Success icon

This version of the integration is available via the API.


Available | | **Singer GitHub repository** | [singer-io/tap-zendesk-chat](https://github.com/singer-io/tap-zendesk-chat) | | | | **REPLICATION SETTINGS** | | | | | **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**

the Info icon

A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Remove icon

Anchor Scheduling is not supported for this integration. The only available replication scheduling method is the Replication Frequency setting.


Unsupported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**

the Info icon

A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Remove icon

Advanced Scheduling is not supported for this integration.


Unsupported | | **Table-level reset**

the Info icon

Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon

Table-level resets are not supported for this integration. Resets are only supported at the integration level.


Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**

the Info icon

Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon

Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.


Unsupported | | **DATA SELECTION** | | | | | **Table selection**

the Info icon

The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | **Column selection**

the Info icon

The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Select all**

the Info icon

Indicates if the integration supports selecting all available tables and columns. | the Success icon

Supported


Supported | | | | **TRANSPARENCY** | | | | | **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**

the Info icon

Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**

the Info icon

Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | ## Connecting Zendesk Chat ### Zendesk Chat setup requirements To set up Zendesk Chat in Stitch, you need: * **Owner permissions in Zendesk Chat**. The user who authorizes the integration must have [Owner permissions in Zendesk Chat](https://support.zendesk.com/hc/en-us/articles/360022182234). Otherwise, Stitch will encounter authentication issues and be unable to replicate data. * **An Advanced or Premium Zendesk Chat account.** Zendesk only allows customers on their Advanced or Paid Zendesk Chat plans to utilize the Rest API, which is what Stitch uses to connect to your Zendesk Chat account and replicate data. If your Zendesk Chat account is on Lite or Basic, you will need to upgrade your Zendesk Chat plan. [More info on Zendesk Chat plans can be found on Zendesk’s website](https://www.zendesk.com/pricing/#everyone). ### Step 1: Add Zendesk Chat as a Stitch data source 1. [Sign into your Stitch account](https://app.stitchdata.com/). 2. On the Stitch Dashboard page, click the **Add Integration** button. 3. Click the **Zendesk Chat** icon. 4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination. For example, the name “Stitch Zendesk Chat” would create a schema called `stitch_zendesk_chat` in the destination. **Note**: Schema names cannot be changed after you save the integration. 5. In the **Zendesk Subdomain** field, enter the subdomain of your Zendesk site. For example, the subdomain of `stitchdata.zendesk.com` would be `stitchdata`. ### Step 2: Define the historical replication start date The Sync Historical Data setting defines the starting date for your Zendesk Chat integration. This means that data **equal to or newer than this date** will be replicated to your data warehouse. Change this setting if you want to replicate data beyond Zendesk Chat’s default setting of **1 year**. For a detailed look at historical replication jobs, check out the [Syncing Historical SaaS Data](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide. ### Step 3: Create a replication schedule Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information. In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins. Zendesk Chat integrations support the following replication scheduling methods: * [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency) To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage. ### Step 4: Authorize Stitch to access Zendesk Chat Lastly, you’ll be directed to Zendesk’s website to complete the setup. 1. Enter your Zendesk Chat credentials and click **Login**. 2. Complete the authorization process. 3. After the authorization process successfully completes, you’ll be redirected back to Stitch. 4. Click **All Done**. ### Initial and historical replication jobs After you finish setting up Zendesk Chat, its **Sync Status** may show as **Pending** on either the Stitch Dashboard or in the Integration Details page. For a new integration, a **Pending** status indicates that Stitch is in the process of scheduling the initial replication job for the integration. **This may take some time to complete.** Information note **Initial replication jobs with Anchor Scheduling** If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information. #### Free historical data loads The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota. Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage. ## Zendesk Chat table reference Information note **Schemas and versioning** Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing. The schema and info displayed below is for **version 1** of this integration. This is the latest version of the Zendesk Chat integration. Information note **Table and column names in your destination** Depending on your destination, table and column names may not appear as they are outlined below. For example: Object names are lowercased in Redshift (`CusTomERs` > `customers`), while case is maintained in PostgreSQL destinations (`CusTomERs` > `CusTomERs`). Refer to the [Loading Guide](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info. ### account The `account` table contains info about accounts within your Zendesk Chat account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | account\_key | | **Useful links** | [account schema on GitHub](https://github.com/singer-io/tap-zendesk-chat/blob/master/tap_zendesk_chat/schemas/account.json "Opens in new tab: account schema on GitHub")


[Zendesk Chat API method](https://developer.zendesk.com/api-reference/live-chat/chat-api/accounts/ "Opens in new tab: Zendesk Chat API method") | account table foreign keys | Join account with | on | | --- | --- | | [goals](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#goals) | ```
account.plan.goals = goals.id
``` | | [chats](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#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. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand billing

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. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand plan

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 [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [agents schema on GitHub](https://github.com/singer-io/tap-zendesk-chat/blob/master/tap_zendesk_chat/schemas/agents.json "Opens in new tab: agents schema on GitHub")


[Zendesk Chat API method](https://developer.zendesk.com/api-reference/live-chat/chat-api/agents/ "Opens in new tab: Zendesk Chat API method") | agents table foreign keys | Join agents with | on | | --- | --- | | [chats](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#chats) | ```
agents.id = chats.agent_ids
```

```
agents.departments = chats.department_id
```

```
agents.departments = chats.history.prev_department_id
``` | | [departments](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#departments) | ```
agents.departments = departments.id
``` | | [shortcuts](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#shortcuts) | ```
agents.departments = shortcuts.departments
``` | agents table schema | **create\_date**


DATE-TIME | | --- | | **departments**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **display\_name**


STRING | | **email**


STRING | | **enabled**


BOOLEAN | | **enabled\_departments**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **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. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand roles

administrator

BOOLEAN

owner

BOOLEAN

| | **scope**


STRING | | **skills**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | ### bans The `bans` table contains info about bans created in your Zendesk Chat account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [bans schema on GitHub](https://github.com/singer-io/tap-zendesk-chat/blob/master/tap_zendesk_chat/schemas/bans.json "Opens in new tab: bans schema on GitHub")


[Zendesk Chat API method](https://developer.zendesk.com/api-reference/live-chat/chat-api/bans/ "Opens in new tab: Zendesk Chat API method") | 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. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | timestamp | | **Useful links** | [chats schema on GitHub](https://github.com/singer-io/tap-zendesk-chat/blob/master/tap_zendesk_chat/schemas/chats.json "Opens in new tab: chats schema on GitHub")


[Zendesk Chat API method](https://developer.zendesk.com/api-reference/live-chat/chat-api/chats/ "Opens in new tab: Zendesk Chat API method") | chats table foreign keys | Join chats with | on | | --- | --- | | [agents](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#agents) | ```
chats.agent_ids = agents.id
```

```
chats.department_id = agents.departments
```

```
chats.history.prev_department_id = agents.departments
``` | | [departments](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#departments) | ```
chats.department_id = departments.id
```

```
chats.history.prev_department_id = departments.id
``` | | [shortcuts](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#shortcuts) | ```
chats.department_id = shortcuts.departments
```

```
chats.history.prev_department_id = shortcuts.departments
``` | | [goals](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#goals) | ```
chats.conversions.goal_id = goals.id
```

```
chats.history.conversion.goal_id = goals.id
``` | | [account](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#account) | ```
chats.conversions.goal_id = account.plan.goals
```

```
chats.history.conversion.goal_id = account.plan.goals
``` | chats table schema | **agent\_ids**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | --- | | **agent\_names**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **comment**


STRING | | **conversions**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand conversions

attribution

OBJECT

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. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand count

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. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand history

channel

STRING

conversion

OBJECT

attribution

OBJECT

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. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand response\_time

avg

NUMBER, INTEGER

first

INTEGER

max

INTEGER

| | **session**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **started\_by**


STRING | | **tags**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **timestamp**


DATE-TIME | | **triggered**


BOOLEAN | | **triggered\_response**


BOOLEAN | | **type**


STRING | | **unread**


BOOLEAN, INTEGER | | **visitor**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand visitor

email

STRING

id

STRING

name

STRING

notes

STRING

phone

STRING

| | **webpath**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **zendesk\_ticket\_id**


INTEGER | ### departments The `departments` table contains info about departments within your Zendesk Chat account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [departments schema on GitHub](https://github.com/singer-io/tap-zendesk-chat/blob/master/tap_zendesk_chat/schemas/departments.json "Opens in new tab: departments schema on GitHub")


[Zendesk Chat API method](https://developer.zendesk.com/api-reference/live-chat/chat-api/departments/ "Opens in new tab: Zendesk Chat API method") | departments table foreign keys | Join departments with | on | | --- | --- | | [shortcuts](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#shortcuts) | ```
departments.id = shortcuts.departments
``` | | [chats](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#chats) | ```
departments.id = chats.department_id
```

```
departments.id = chats.history.prev_department_id
``` | | [agents](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#agents) | ```
departments.id = agents.departments
``` | departments table schema | **description**


STRING | | --- | | **enabled**


BOOLEAN | | **id**


INTEGER | | **members**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **name**


STRING | | **settings**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | ### goals The `goals` table contains info about URL-based goals set within your Zendesk Chat account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Useful links** | [goals schema on GitHub](https://github.com/singer-io/tap-zendesk-chat/blob/master/tap_zendesk_chat/schemas/goals.json "Opens in new tab: goals schema on GitHub")


[Zendesk Chat API method](https://developer.zendesk.com/api-reference/live-chat/chat-api/goals/ "Opens in new tab: Zendesk Chat API method") | goals table foreign keys | Join goals with | on | | --- | --- | | [chats](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#chats) | ```
goals.id = chats.conversions.goal_id
```

```
goals.id = chats.history.conversion.goal_id
``` | | [account](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#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. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand settings

conditions

ARRAY

operator

STRING

type

STRING

value

STRING

| ### shortcuts The `shortcuts` table contains info about shortcuts within your Zendesk Chat account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | name | | **Useful links** | [shortcuts schema on GitHub](https://github.com/singer-io/tap-zendesk-chat/blob/master/tap_zendesk_chat/schemas/shortcuts.json "Opens in new tab: shortcuts schema on GitHub")


[Zendesk Chat API method](https://developer.zendesk.com/api-reference/live-chat/chat-api/shortcuts/ "Opens in new tab: Zendesk Chat API method") | shortcuts table foreign keys | Join shortcuts with | on | | --- | --- | | [departments](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#departments) | ```
shortcuts.departments = departments.id
``` | | [chats](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#chats) | ```
shortcuts.departments = chats.department_id
```

```
shortcuts.departments = chats.history.prev_department_id
``` | | [agents](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk-chat#agents) | ```
shortcuts.departments = agents.departments
``` | shortcuts table schema | **agents**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | --- | | **departments**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **id**


STRING | | **message**


STRING | | **name**


STRING | | **options**


STRING | | **scope**


STRING | | **tags**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | ### triggers The `triggers` table contains info about triggers within your Zendesk Chat account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [triggers schema on GitHub](https://github.com/singer-io/tap-zendesk-chat/blob/master/tap_zendesk_chat/schemas/shortcuts.json "Opens in new tab: triggers schema on GitHub")


[Zendesk Chat API method](https://developer.zendesk.com/api-reference/live-chat/chat-api/triggers/#list-triggers "Opens in new tab: Zendesk Chat API method") | triggers table schema | **definition**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand definition

actions

STRING

condition

STRING

event

STRING

version

INTEGER

| | --- | | **description**


STRING | | **enabled**


BOOLEAN | | **id**


INTEGER | | **name**


STRING |