Release Status Closed Beta Availability Free
Status Page zendesk-chat Status Page Default Historical Sync 1 year
Whitelist Tables/Columns Unsupported/Unsupported Default Replication Frequency 30 minutes
Full Table Endpoints 7 Incremental Endpoints 1
Destination Incompatibilities None

Connecting zendesk-chat

Connecting your zendesk-chat data to Stitch is a four-step process:

  1. Add zendesk-chat as a Stitch data source
  2. Define the Historical Sync
  3. Define the Replication Frequency
  4. Authorize Stitch to access Zopim

Add zendesk-chat as a Stitch Data Source

  1. On the Stitch Dashboard page, click the Add an Integration button.

  2. Click the zendesk-chat icon.

  3. Enter a name for the integration. This is the name that will display on the for the integration; it’ll also be used to create the schema in your data warehouse.

    For example, the name “Stitch zendesk-chat” would create a schema called stitch_zendesk-chat in the data warehouse. This schema is where all the tables for this integration will be stored.

Defining the Historical Sync

The Sync Historical Data setting will define 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 sync data beyond zendesk-chat’s default setting of 1 year. For a detailed look at historical syncs, check out the Syncing Historical SaaS Data article.

Define the Replication Frequency

The Replication Frequency controls how often Stitch will attempt to replicate data from your zendesk-chat integration. By default the frequency is set to 30 minutes, but you can change it to better suit your needs.

Before setting the Replication Frequency, note that:

  • The more often zendesk-chat is set to replicate, the higher the number of replicated rows.

  • The number of rows in the source may not equal the number of rows replicated by Stitch. Tables that use Full Table Replication will result in a higher number of replicated rows.

  • If you’re using a data warehouses that doesn’t natively support nested structures, you’ll see a higher number of replicated rows due to the de-nesting Stitch performs.

To help prevent overages, we recommend setting the Replication Frequency to something less frequent - like 6 hours instead of 30 minutes. For tips on reducing your row count, check out the Reducing Your Row Count section of our Billing Guide.

After selecting a Replication Frequency, click Save Integration.

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

zendesk-chat’s Intial Sync

After you finish setting up zendesk-chat, you might see its Sync Status 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 sync for the integration. This may take some time to complete.

zendesk-chat Schema

Stitch's zendesk-chat integration includes these tables:


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: 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, please reach out to us.

Tags: saas integrations