# Zendesk Support (v2)
Information note **Zendesk Support extraction is supported by Stitch**
This integration is powered by [Singer's](https://www.singer.io/) Zendesk Support tap and certified by Stitch. [Check out and contribute to the repo on GitHub](https://github.com/singer-io/tap-zendesk).
For support, contact [Support](https://community.qlik.com/t5/Support/ct-p/qlikSupport).
## Zendesk Support integration summary
Stitch’s Zendesk Support integration replicates data using the [Zendesk Support API](https://developer.zendesk.com/rest_api/docs/support/introduction). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#schema) section for a list of objects available for replication.
## Zendesk Support feature snapshot
A high-level look at Stitch's Zendesk Support (v2) 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 May 24, 2023 | **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.
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.
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
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 Support
### Zendesk Support setup requirements
To set up Zendesk Support in Stitch, you need:
* **Administrator permissions in Zendesk Support**. Some data types in Zendesk Support may only be accessed with Admin permissions. For example: To replicate ticket metric or tag data, Zendesk Support’s API requires a user with Admin permissions.
To ensure you can replicate all the data you need, we recommend a user with Admin permissions set up the integration.
* **A specific Zendesk Support plan if replicating ticket forms or SLA policies:**
* To replicate **SLA policies**, you must be on an Enterprise or Professional Zendesk Support plan.
* To replicate **ticket forms**, you must be on an Enterprise Zendesk Support plan, or a Professional Zendesk Support plan with the ticket forms add-on.
All other tables, with the exception of `sla_policies` and `ticket_forms` will be available for replication even if you aren’t on either of these Zendesk Support plans.
### Step 1: Add Zendesk Support 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 Support** 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 Support” would create a schema called `stitch_zendesk_support` in the destination. **Note**: Schema names cannot be changed after you save the integration.
5. In the **Zendesk Subdomain** field, enter your Zendesk Support site prefix. For example: For `stitchdata.zendesk.com`, only `stitchdata` would be entered into this field.
### Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Zendesk Support 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 Support’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 Support integrations support the following replication scheduling methods:
* [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency)
* [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)
* [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only)
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 Support
Information note **Note**: A Zendesk Support user with Admin permissions must complete this step.
1. Next, you’ll be prompted to sign into your Zendesk Support account.
2. After the authorization process is successfully completed, you’ll be directed back to Stitch.
3. Click **All Done**.
### Step 5: Set objects to replicate
Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements).
The last step is to select the tables and columns you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#schema)
**Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts.
* Selection options
* Individual tables and columns
* All tables and columns
For Zendesk Support integrations, you can select:
1. **Individual tables and columns**
2. **All tables and columns**
Click the tabs to view instructions for each selection method.
1. In the integration’s **Tables to Replicate tab**, locate a table you want to replicate.
2. To track a table, click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate.
3. To track a column, click the **checkbox** next to the column’s name. A blue checkmark means the column is set to replicate.
4. Repeat this process for all the tables and columns you want to replicate.
5. When finished, click the **Finalize Your Selections** button at the bottom of the screen to save your selections.
Information note **Important**: Using the **Select All** feature will overwrite any previous selections. However, selections aren’t final until **Finalize Your Selections** is clicked. Clicking **Cancel** will restore your previous selections. Refer to the [Select All guide](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature.
1. Click into the integration from the Stitch Dashboard page.
2. Click the **Tables to Replicate** tab.
3. In the list of tables, click the box next to the **Table Names** column.
4. In the menu that displays, click **Track all Tables and Fields**:
The Track all Tables and Fields menu in the Tables to Replicate tabThe Track all Tables and Fields menu in the Tables to Replicate tab
5. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections.
### Initial and historical replication jobs
After you finish setting up Zendesk Support, 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 Support replication
### Replicating SLA policies and ticket forms
To replicate SLA policies and ticket forms - or the `sla_policies` and `ticket_forms` tables - you need to be on an Enterprise or Professional Zendesk Support plan. [To replicate `ticket_forms` on a Professional plan](https://support.zendesk.com/hc/en-us/articles/203661616-Creating-ticket-forms-to-support-multiple-request-types-Professional-add-on-and-Enterprise-), you’ll also need to have the ticket forms add-on enabled in your Zendesk Support account.
If you set either table to replicate and don’t meet the requirements listed above, an error similar to the following will surface in the integration’s [Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs):
```
tap - INFO replicated 0 records from "ticket_forms" endpoint
tap - CRITICAL {"error": {"message": "You do not have access to this page. Please contact the account owner of this help desk for further help.", "title": "Forbidden"}}
```
To resolve the error, de-select the appropriate table(s). Reach out to Zendesk if you have questions about your Zendesk plan.
### Replicating user and organization custom fields
To replicate custom fields for Users and Organizations - or the `users` and `organizations` tables - [you need to be on an Enterprise, Professional, or Team Zendesk plan](https://support.zendesk.com/hc/en-us/articles/203662066-Adding-custom-fields-to-users).
If you set custom fields in the `users` or `organizations` tables to replicate and don’t meet the requirements listed above, an error similar to the following will surface in the integration’s [Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs):
```
tap - WARNING The account credentials supplied do not have access to `organizations` custom fields.
tap - WARNING The account credentials supplied do not have access to `users` custom fields.
```
To resolve the error, de-select the appropriate field(s). Reach out to Zendesk if you have questions about your Zendesk plan.
## Zendesk Support 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 2** of this integration.
This is the latest version of the Zendesk Support 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.
### 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 [](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 ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/group_memberships "Opens in new tab: Zendesk Support documentation")
[group_memberships schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/group_memberships.json "Opens in new tab: group_memberships schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/group_memberships#list-memberships "Opens in new tab: Zendesk Support API method") |
group\_memberships table foreign keys
| Join group\_memberships with | on |
| --- | --- |
| [groups](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#groups) | ``` group_memberships.group_id = groups.id ``` |
| [organizations](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#organizations) | ``` group_memberships.group_id = organizations.group_id ``` |
| [satisfaction_ratings](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#satisfaction-ratings) | ``` group_memberships.group_id = satisfaction_ratings.group_id ``` |
| [tickets](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#tickets) | ``` group_memberships.group_id = tickets.group_id ``` |
| [users](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#users) | ``` group_memberships.group_id = users.default_group_id ``` |
group\_memberships table schema
| **created\_at**
DATE-TIME |
| --- |
| **default**
BOOLEAN |
| **group\_id**
INTEGER |
| **id**
INTEGER |
| **updated\_at**
DATE-TIME |
| **url**
STRING |
| **user\_id**
INTEGER |
### 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 [](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 ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/groups "Opens in new tab: Zendesk Support documentation")
[groups schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/groups.json "Opens in new tab: groups schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/groups#list-groups "Opens in new tab: Zendesk Support API method") |
groups table foreign keys
| Join groups with | on |
| --- | --- |
| [group_memberships](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#group-memberships) | ``` groups.id = group_memberships.group_id ``` |
| [organizations](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#organizations) | ``` groups.id = organizations.group_id ``` |
| [satisfaction_ratings](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#satisfaction-ratings) | ``` groups.id = satisfaction_ratings.group_id ``` |
| [tickets](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#tickets) | ``` groups.id = tickets.group_id ``` |
| [users](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#users) | ``` groups.id = users.default_group_id ```
STRING |
### 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 [](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 ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/macros "Opens in new tab: Zendesk Support documentation")
[macros schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/macros.json "Opens in new tab: macros schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/macros#list-macros "Opens in new tab: Zendesk Support API method") |
macros table foreign keys
| Join macros with | on |
| --- | --- |
| [ticket_audits](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#ticket-audits) | ``` macros.id = ticket_audits.events.macro_id ``` |
| [groups](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#groups) | ``` macros.restriction.id = groups.id ``` |
| [users](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#users) | ``` macros.restriction.id = users.id ``` |
macros table schema
| **actions**
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 actions
field
STRING
value
STRING
|
| --- |
| **active**
BOOLEAN |
| **created\_at**
DATE-TIME |
| **description**
STRING |
| **id**
INTEGER |
| **position**
INTEGER |
| **restriction**
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 restriction
id
INTEGER
ids
ARRAY
type
STRING
|
| **title**
STRING |
| **updated\_at**
DATE-TIME |
| **url**
STRING |
### organizations
The `organizations` table contains information about the organizations your end-users belong to.
#### Custom organization fields
Stitch’s 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 [](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 ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/organizations "Opens in new tab: Zendesk Support documentation")
[organizations schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/organizations.json "Opens in new tab: organizations schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/incremental_export#incremental-organization-export "Opens in new tab: Zendesk Support API method") |
organizations table foreign keys
| Join organizations with | on |
| --- | --- |
| [groups](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#groups) | ``` organizations.group_id = groups.id ``` |
| [group_memberships](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#group-memberships) | ``` organizations.group_id = group_memberships.group_id ``` |
| [satisfaction_ratings](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#satisfaction-ratings) | ``` organizations.group_id = satisfaction_ratings.group_id ``` |
| [tickets](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#tickets) | ``` organizations.group_id = tickets.group_id ```
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>. |
| **external\_id**
STRING |
| **group\_id**
INTEGER |
| **id**
INTEGER |
| **name**
STRING |
| **notes**
STRING |
| **organization\_fields**
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>. |
| **shared\_comments**
BOOLEAN |
| **shared\_tickets**
BOOLEAN |
| **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>. |
| **updated\_at**
DATE-TIME |
| **url**
STRING |
### 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 [](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 ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/satisfaction_ratings "Opens in new tab: Zendesk Support documentation")
[satisfaction_ratings schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/satisfaction_ratings.json "Opens in new tab: satisfaction_ratings schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/satisfaction_ratings#list-satisfaction-ratings "Opens in new tab: Zendesk Support API method") |
satisfaction\_ratings table foreign keys
| Join satisfaction\_ratings with | on |
| --- | --- |
| [groups](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#groups) | ``` satisfaction_ratings.group_id = groups.id ``` |
| [group_memberships](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#group-memberships) | ``` satisfaction_ratings.group_id = group_memberships.group_id ``` |
| [organizations](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#organizations) | ``` satisfaction_ratings.group_id = organizations.group_id ``` |
| [tickets](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#tickets) | ``` satisfaction_ratings.group_id = tickets.group_id ```
STRING |
### 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 [](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 ** | id |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/sla_policies "Opens in new tab: Zendesk Support documentation")
[sla_policies schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/sla_policies.json "Opens in new tab: sla_policies schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/sla_policies#list-sla-policies "Opens in new tab: Zendesk Support API method") |
sla\_policies table schema
| **created\_at**
DATE-TIME |
| --- |
| **description**
STRING |
| **filter**
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 filter
all
ARRAY
field
STRING
operator
STRING
value
STRING
any
ARRAY
field
STRING
operator
STRING
value
STRING
|
| **id**
INTEGER |
| **policy\_metrics**
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 policy\_metrics
business_hours
BOOLEAN
priority
STRING
target
INTEGER
|
| **position**
INTEGER |
| **title**
STRING |
| **updated\_at**
DATE-TIME |
| **url**
STRING |
### tags
The `tags` table contains the names and total number of applications of tags in your Zendesk Support account. Only the 20,000 most popular tags used in the last 60 days are extracted.
**Note**: Retrieving tag data requires Zendesk Support Admin permissions.
| **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 ** | name |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/tags "Opens in new tab: Zendesk Support documentation")
[tags schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/tags.json "Opens in new tab: tags schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/tags#list-tags "Opens in new tab: Zendesk Support API method") |
tags table foreign keys
| Join tags with | on |
| --- | --- |
| [organizations](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#organizations) | ``` tags.name = organizations.tags ``` |
| [tickets](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#tickets) | ``` tags.name = tickets.tags ``` |
| [users](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#users) | ``` tags.name = users.tags ``` |
tags table schema
| **count**
INTEGER |
| --- |
| **name**
STRING |
### talk\_phone\_numbers
This table contains data about phone numbers in Zendesk Talk.
| **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 ** | id |
| **Useful links** | [talk_phone_numbers schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/talk_phone_numbers.json "Opens in new tab: talk_phone_numbers schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/api-reference/voice/talk-api/phone_numbers/ "Opens in new tab: Zendesk Support API method") |
talk\_phone\_numbers table schema
| **capabilities**
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 capabilities
mms
BOOLEAN
sms
BOOLEAN
voice
BOOLEAN
|
| --- |
| **categorised\_greetings**
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>. |
| **categorised\_greetings\_with\_sub\_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>. |
| **country\_code**
STRING |
| **created\_at**
DATE-TIME |
| **default\_greeting\_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>. |
| **default\_group\_id**
INTEGER |
| **display\_number**
STRING |
| **external**
BOOLEAN |
| **greeting\_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>. |
| **group\_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>. |
| **id**
INTEGER |
| **ivr\_id**
INTEGER |
| **line\_type**
STRING |
| **location**
STRING |
| **name**
STRING |
| **nickname**
STRING |
| **number**
STRING |
| **outbound\_enabled**
BOOLEAN |
| **priority**
INTEGER |
| **recorded**
BOOLEAN |
| **schedule\_id**
INTEGER |
| **sms\_enabled**
BOOLEAN |
| **sms\_group\_id**
INTEGER |
| **token**
STRING |
| **toll\_free**
BOOLEAN |
| **transcription**
BOOLEAN |
| **voice\_enabled**
BOOLEAN |
### 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](https://developer.zendesk.com/rest_api/docs/support/ticket_audits#audit-events).
#### 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 [](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)** | Append-Only Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | created\_at |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/ticket_audits "Opens in new tab: Zendesk Support documentation")
[ticket_audits schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/ticket_audits.json "Opens in new tab: ticket_audits schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/support/core/ticket_audits#list-all-ticket-audits "Opens in new tab: Zendesk Support API method") |
ticket\_audits table foreign keys
| Join ticket\_audits with | on |
| --- | --- |
| [macros](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#macros) | ``` ticket_audits.events.macro_id = macros.id ``` |
| [ticket_comments](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#ticket-comments) | ``` ticket_audits.id = ticket_comments.audit_id ```
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 events
attachments
ARRAY
audit_id
INTEGER
author_id
INTEGER
body
STRING
created_at
DATE-TIME
data
OBJECT
answered_by_id
INTEGER
answered_by_name
STRING
call_duration
STRING
from
STRING
recording_url
STRING
started_at
DATE-TIME
to
STRING
transcription_status
STRING
transcription_text
STRING
field_name
STRING
formatted_from
STRING
formatted_to
STRING
html_body
STRING
id
INTEGER
macro_deleted
BOOLEAN
macro_id
STRING
macro_title
STRING
plain_body
STRING
previous_value
ARRAY, STRING
public
BOOLEAN
recipients
ARRAY
resource
STRING
subject
STRING
trusted
BOOLEAN
type
STRING
value
ARRAY, STRING
via
OBJECT
channel
STRING
source
OBJECT
from
OBJECT
address
STRING
deleted
BOOLEAN
id
INTEGER
name
STRING
original_recipients
ARRAY
revision_id
INTEGER
subject
STRING
ticket_id
INTEGER
title
STRING
rel
STRING
to
OBJECT
address
STRING
name
STRING
|
| **id**
INTEGER |
| **metadata**
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 metadata
flags
ARRAY
flags_options
OBJECT
11
OBJECT
message
OBJECT
user
STRING
trusted
BOOLEAN
2
OBJECT
trusted
BOOLEAN
notifications_suppressed_for
ARRAY
system
OBJECT
client
STRING
ip_address
STRING
json_email_identifier
STRING
latitude
NUMBER
location
STRING
longitude
NUMBER
message_id
STRING
raw_email_identifier
STRING
trusted
BOOLEAN
|
| **ticket\_id**
INTEGER |
| **via**
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 via
channel
STRING
source
OBJECT
from
OBJECT
address
STRING
deleted
BOOLEAN
id
INTEGER
name
STRING
original_recipients
ARRAY
subject
STRING
ticket_id
INTEGER
ticket_ids
ARRAY
title
STRING
rel
STRING
to
OBJECT
address
STRING
name
STRING
|
### 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 [](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 ** | id |
| **Replication Key ** | created\_at |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/ticket_comments "Opens in new tab: Zendesk Support documentation")
[ticket_comments schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/ticket_comments.json "Opens in new tab: ticket_comments schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/ticket_comments#list-comments "Opens in new tab: Zendesk Support API method") |
ticket\_comments table foreign keys
| Join ticket\_comments with | on |
| --- | --- |
| [ticket_audits](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#ticket-audits) | ``` ticket_comments.audit_id = ticket_audits.id ```
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>. |
| --- |
| **audit\_id**
INTEGER |
| **author\_id**
INTEGER |
| **body**
STRING |
| **created\_at**
DATE-TIME |
| **html\_body**
STRING |
| **id**
INTEGER |
| **metadata**
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 metadata
flags
ARRAY
flags_options
OBJECT
11
OBJECT
message
OBJECT
user
STRING
trusted
BOOLEAN
2
OBJECT
trusted
BOOLEAN
notifications_suppressed_for
ARRAY
system
OBJECT
client
STRING
ip_address
STRING
json_email_identifier
STRING
latitude
NUMBER
location
STRING
longitude
NUMBER
message_id
STRING
raw_email_identifier
STRING
trusted
BOOLEAN
|
| **plain\_body**
STRING |
| **public**
BOOLEAN |
| **ticket\_id**
INTEGER |
| **type**
STRING |
| **via**
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 via
channel
STRING
source
OBJECT
from
OBJECT
address
STRING
deleted
BOOLEAN
id
INTEGER
name
STRING
original_recipients
ARRAY
subject
STRING
ticket_id
INTEGER
ticket_ids
ARRAY
title
STRING
rel
STRING
to
OBJECT
address
STRING
name
STRING
|
### 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 [](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 ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/ticket_fields "Opens in new tab: Zendesk Support documentation")
[ticket_fields schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/ticket_fields.json "Opens in new tab: ticket_fields schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/ticket_fields#list-ticket-fields "Opens in new tab: Zendesk Support API method") |
ticket\_fields table foreign keys
| Join ticket\_fields with | on |
| --- | --- |
| [ticket_forms](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#ticket-forms) | ``` ticket_fields.id = ticket_forms.ticket_field_ids ``` |
| [tickets](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#tickets) | ``` ticket_fields.id = tickets.custom_fields.id ``` |
ticket\_fields table schema
| **active**
BOOLEAN |
| --- |
| **agent\_description**
STRING |
| **collapsed\_for\_agents**
BOOLEAN |
| **created\_at**
DATE-TIME |
| **custom\_field\_options**
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 custom\_field\_options
default
BOOLEAN
id
INTEGER
name
STRING
raw_name
STRING
value
STRING
|
| **description**
STRING |
| **editable\_in\_portal**
BOOLEAN |
| **id**
INTEGER |
| **position**
INTEGER |
| **raw\_description**
STRING |
| **raw\_title**
STRING |
| **raw\_title\_in\_portal**
STRING |
| **regexp\_for\_validation**
STRING |
| **removable**
BOOLEAN |
| **required**
BOOLEAN |
| **required\_in\_portal**
BOOLEAN |
| **sub\_type\_id**
INTEGER |
| **system\_field\_options**
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>. |
| **tag**
STRING |
| **title**
STRING |
| **title\_in\_portal**
STRING |
| **type**
STRING |
| **updated\_at**
DATE-TIME |
| **url**
STRING |
| **visible\_in\_portal**
BOOLEAN |
### 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 [](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 ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/ticket_forms "Opens in new tab: Zendesk Support documentation")
[ticket_forms schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/ticket_forms.json "Opens in new tab: ticket_forms schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/ticket_forms#list-ticket-forms "Opens in new tab: Zendesk Support API method") |
ticket\_forms table foreign keys
| Join ticket\_forms with | on |
| --- | --- |
| [ticket_fields](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#ticket-fields) | ``` ticket_forms.ticket_field_ids = ticket_fields.id ``` |
| [tickets](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#tickets) | ``` ticket_forms.ticket_field_ids = tickets.custom_fields.id ```
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>. |
| **ticket\_field\_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>. |
| **updated\_at**
DATE-TIME |
| **url**
STRING |
### ticket\_metric\_events
This table contains data about reply times, agent work times, and requester wait times.
| **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 ** | id |
| **Replication Key ** | time |
| **Useful links** | [ticket_metric_events schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/ticket_metric_events.json "Opens in new tab: ticket_metric_events schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metric_events/ "Opens in new tab: Zendesk Support API method") |
ticket\_metric\_events table schema
| **deleted**
BOOLEAN |
| --- |
| **id**
INTEGER |
| **instance\_id**
INTEGER |
| **metric**
STRING |
| **sla**
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 sla
business_hours
BOOLEAN
policy
OBJECT
description
STRING
id
INTEGER
title
STRING
target
INTEGER
|
| **status**
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 status
business
INTEGER
calendar
INTEGER
|
| **ticket\_id**
INTEGER |
| **time**
DATE-TIME |
| **type**
STRING |
### 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](https://support.zendesk.com/hc/en-us/articles/203690936).
| **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 ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/ticket_metrics "Opens in new tab: Zendesk Support documentation")
[ticket_metrics schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/ticket_metrics.json "Opens in new tab: ticket_metrics schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/ticket_metrics#list-ticket-metrics "Opens in new tab: Zendesk Support API method") |
ticket\_metrics table foreign keys
| Join ticket\_metrics with | on |
| --- | --- |
| [satisfaction_ratings](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#satisfaction-ratings) | ``` ticket_metrics.ticket_id = satisfaction_ratings.ticket_id ``` |
| [tickets](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#tickets) | ``` ticket_metrics.ticket_id = tickets.id ``` |
| [ticket_audits](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#ticket-audits) | ``` ticket_metrics.ticket_id = ticket_audits.ticket_id ``` |
| [ticket_comments](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#ticket-comments) | ``` ticket_metrics.ticket_id = ticket_comments.ticket_id ``` |
ticket\_metrics table schema
| **agent\_wait\_time\_in\_minutes**
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>.
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 first\_resolution\_time\_in\_minutes
business
INTEGER
calendar
INTEGER
|
| **full\_resolution\_time\_in\_minutes**
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 full\_resolution\_time\_in\_minutes
business
INTEGER
calendar
INTEGER
|
| **group\_stations**
INTEGER |
| **id**
INTEGER |
| **initially\_assigned\_at**
DATE-TIME |
| **instance\_id**
INTEGER |
| **latest\_comment\_added\_at**
DATE-TIME |
| **metric**
STRING |
| **on\_hold\_time\_in\_minutes**
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 on\_hold\_time\_in\_minutes
business
INTEGER
calendar
INTEGER
|
| **reopens**
INTEGER |
| **replies**
INTEGER |
| **reply\_time\_in\_minutes**
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>.
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 requester\_wait\_time\_in\_minutes
business
INTEGER
calendar
INTEGER
|
| **solved\_at**
DATE-TIME |
| **status**
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 status
business
INTEGER
calendar
INTEGER
|
| **status\_updated\_at**
DATE-TIME |
| **ticket\_id**
INTEGER |
| **time**
STRING |
| **type**
STRING |
| **updated\_at**
DATE-TIME |
| **url**
STRING |
### 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
Stitch’s Zendesk Support integration will replicate all custom ticket fields.
| **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 ** | id |
| **Replication Key ** | generated\_timestamp |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/tickets "Opens in new tab: Zendesk Support documentation")
[tickets schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/tickets.json "Opens in new tab: tickets schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/incremental_export#incremental-ticket-export "Opens in new tab: Zendesk Support API method") |
tickets table foreign keys
| Join tickets with | on |
| --- | --- |
| [groups](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#groups) | ``` tickets.group_id = groups.id ``` |
| [group_memberships](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#group-memberships) | ``` tickets.group_id = group_memberships.group_id ``` |
| [organizations](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#organizations) | ``` tickets.group_id = organizations.group_id ```
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>. |
| **created\_at**
DATE-TIME |
| **custom\_fields**
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 custom\_fields
id
INTEGER
|
| **description**
STRING |
| **due\_at**
DATE-TIME |
| **email\_cc\_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>. |
| **external\_id**
STRING |
| **follower\_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>. |
| **followup\_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>. |
| **forum\_topic\_id**
INTEGER |
| **generated\_timestamp**
INTEGER |
| **group\_id**
INTEGER |
| **has\_incidents**
BOOLEAN |
| **id**
INTEGER |
| **is\_public**
BOOLEAN |
| **organization\_id**
INTEGER |
| **priority**
STRING |
| **problem\_id**
INTEGER |
| **raw\_subject**
STRING |
| **recipient**
STRING |
| **requester\_id**
INTEGER |
| **satisfaction\_rating**
OBJECT, STRING
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 satisfaction\_rating
assignee_id
INTEGER
comment
STRING
created_at
DATE-TIME
group_id
INTEGER
id
INTEGER
reason
STRING
reason_id
INTEGER
requester_id
INTEGER
score
STRING
ticket_id
INTEGER
updated_at
DATE-TIME
url
STRING
|
| **sharing\_agreement\_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>. |
| **status**
STRING |
| **subject**
STRING |
| **submitter\_id**
INTEGER |
| **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>. |
| **ticket\_form\_id**
INTEGER |
| **type**
STRING |
| **updated\_at**
DATE-TIME |
| **url**
STRING |
| **via**
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 via
channel
STRING
source
OBJECT
from
OBJECT
address
STRING
name
STRING
subject
STRING
ticket_id
INTEGER
rel
STRING
to
OBJECT
address
STRING
name
STRING
|
### 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
Stitch’s 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 [](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 ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [Zendesk Support documentation](https://developer.zendesk.com/rest_api/docs/support/users "Opens in new tab: Zendesk Support documentation")
[users schema on GitHub](https://github.com/singer-io/tap-zendesk/blob/master/tap_zendesk/schemas/users.json "Opens in new tab: users schema on GitHub")
[Zendesk Support API method](https://developer.zendesk.com/rest_api/docs/support/incremental_export#incremental-user-export "Opens in new tab: Zendesk Support API method") |
users table foreign keys
| Join users with | on |
| --- | --- |
| [groups](https://help.qlik.com/en-US/stitch/integrations/saas/zendesk#groups) | ``` users.default_group_id = groups.id ```
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>. |
| **report\_csv**
BOOLEAN |
| **restricted\_agent**
BOOLEAN |
| **role**
STRING |
| **role\_type**
INTEGER |
| **shared**
BOOLEAN |
| **shared\_agent**
BOOLEAN |
| **shared\_phone\_number**
BOOLEAN |
| **signature**
STRING |
| **suspended**
BOOLEAN |
| **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>. |
| **ticket\_restriction**
STRING |
| **time\_zone**
STRING |
| **two\_factor\_auth\_enabled**
BOOLEAN |
| **updated\_at**
DATE-TIME |
| **url**
STRING |
| **user\_fields**
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>. |
| **verified**