Zendesk Chat integration summary

Stitch’s Zendesk Chat integration replicates data using the Zendesk Chat API. Refer to the Schema section for a list of objects available for replication.

Zendesk Chat feature snapshot

A high-level look at Stitch's Zendesk Chat (v17-12-2017) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Deprecated on November 15, 2022

 Supported by

Singer Community
Stitch plan

Standard

 API availability

Not available
Singer GitHub repository

Not applicable
REPLICATION SETTINGS
Anchor Scheduling

Unsupported

 Advanced Scheduling

Unsupported
Table-level reset

Unsupported

 Configurable Replication Methods

Unsupported
DATA SELECTION
Table selection

Unsupported

 Column selection

Unsupported
Select all

Unsupported
TRANSPARENCY
Extraction Logs

Unsupported

 Loading Reports

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

Step 1: Add Zendesk Chat as a Stitch data source

  1. Sign into your Stitch account.

  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.

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:

  • For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
  • For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.

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

Step 3: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. 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:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide 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.

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.

Zendesk Chat table reference


zopim_account

Replication Method: Full Table
Primary Key: account_key
Contains Nested Structures?: No

The zopim_account table contains info about your Zopim account.

Table Info & Attributes

zopim_account Attributes

While we try to include everything Zendesk Chat has here, this may not be a full list of attributes. Refer to Zendesk Chat's documentation for a full list and description of each attribute.

  • Widget Key (account_key)

  • create_date

  • status

  • plan

  • billing

zopim_agents

Replication Method: Full Table
Primary Key: id
Contains Nested Structures?: Yes

The zopim_agents table contains info about the agents in your Zopim account.

Table Info & Attributes

zopim_agents & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

zopim_agents Attributes

While we try to include everything Zendesk Chat has here, this may not be a full list of attributes. Refer to Zendesk Chat's documentation for a full list and description of each attribute.

  • Agent ID (id)

  • first_name

  • last_name

  • display_name

  • create_date

  • email

  • role

  • enabled

  • departments*

zopim_banned_ips

Replication Method: Full Table
Primary Key: id
Contains Nested Structures?: No

The zopim_banned_ips table contains info about the IPs banned from your Zopim account.

Table Info & Attributes

zopim_banned_ips Attributes

While we try to include everything Zendesk Chat has here, this may not be a full list of attributes. Refer to Zendesk Chat's documentation for a full list and description of each attribute.

  • Banned IP ID (id)

  • ip_address

  • reason

  • type

zopim_banned_visitors

Replication Method: Full Table
Primary Key: id
Contains Nested Structures?: No

The zopim_banned_visitors table contains info about the visitors banned from your Zopim account.

Table Info & Attributes

zopim_banned_visitors Attributes

While we try to include everything Zendesk Chat has here, this may not be a full list of attributes. Refer to Zendesk Chat's documentation for a full list and description of each attribute.

  • Ban ID (id)

  • ip_address

  • visitor_id

  • visitor_name

  • reason

  • type

zopim_chats

Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?: Yes

The zopim_chats table contains info about the chats in your Zopim account.

Table Info & Attributes

zopim_chats & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

Chat Types & Null Values

Depending on the type of chat - support versus offline - some records may have NULL values. Offline chats will only have some of the attributes listed below populated.

zopim_chats Attributes

While we try to include everything Zendesk Chat has here, this may not be a full list of attributes. Refer to Zendesk Chat's documentation for a full list and description of each attribute.

  • Chat ID (id)

  • visitor

  • type

  • started_by

  • session

  • timestamp

  • count

  • duration

  • department_id

  • department_name

  • response_time

  • agent_names*

  • agent_ids*

  • triggered

  • triggered_response

  • unread

  • missed

  • history

  • tags*

  • rating

  • comment

  • webpath*

  • zendesk_ticket_id

zopim_departments

Replication Method: Full Table
Primary Key: id
Contains Nested Structures?: Yes

The zopim_departments table contains info about the departments in your Zopim account.

Table Info & Attributes

zopim_departments & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

zopim_departments Attributes

While we try to include everything Zendesk Chat has here, this may not be a full list of attributes. Refer to Zendesk Chat's documentation for a full list and description of each attribute.

  • Department ID (id)

  • name

  • description

  • enabled

  • members*

  • settings

zopim_shortcuts

Replication Method: Full Table
Primary Key: name
Contains Nested Structures?: Yes

The zopim_shortcuts table contains info about the shortcuts in your Zopim account.

Table Info & Attributes

zopim_shortcuts & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

zopim_shortcuts Attributes

While we try to include everything Zendesk Chat has here, this may not be a full list of attributes. Refer to Zendesk Chat's documentation for a full list and description of each attribute.

  • Shortcut Name (name)

  • options

  • message

  • tags*

zopim_triggers

Replication Method: Full Table
Primary Key: name
Contains Nested Structures?: No

The zopim_triggers table contains info about the triggers in your Zopim account.

Table Info & Attributes

zopim_triggers Attributes

While we try to include everything Zendesk Chat has here, this may not be a full list of attributes. Refer to Zendesk Chat's documentation for a full list and description of each attribute.

  • Trigger Name (name)

  • enabled

  • description

Related Troubleshooting
Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.