Stitch Documentation
has moved!

Please update your bookmarks to https://www.stitchdata.com/docs

If you're not automatically redirected after 5 seconds, click here.

Expected Zopim Data

We're currently doing some private testing on our Zopim integration. Want to be a part of it? Get in touch with us.

Now that Zopim is successfully connected to your Stitch account, what comes next? In this article, we'll cover:

Replicating Zopim Data

Historical Sync

By default, a historical sync of Zopim data goes back one year from the Stitch connection date.

Frequency

Stitch will replicate Zopim data based on the frequency you define. The default setting is every 30 minutes, but you can change it to better suit your needs.

Replication Method

The majority of Zopim data is replicated using Full Table Replication. This means that every time Zopim data is queued for replication, all rows in a table - including existing, new, and updated - will be replicated.

The only exception to this is the zopim_chats table which uses Incremental Replication. This also tends to be the largest table.

Zopim & Row Count Impact
When setting the Replication Frequency for your Zopim integration, keep in mind that all tables except one use Full Table Replication. Even though zopim_chats tends to be the largest table and it uses Incremental Replication, if you set Zopim to replicate more frequently you could quickly use up your quota.

To adjust for this, we recommend decreasing the Replication Frequency. For example: Zopim replicates every 6 hours instead of every 30 minutes.

For more tips on reducing your row count, check out this doc.

Zopim Tables in Your Data Warehouse

Below is a list of the main and subtables that will be created in your data warehouse. Because Zopim uses nested arrays to structure data in some of its API's endpoints, Stitch will de-nest these arrays and create subtables. Refer to the Handling of Nested Data Structures doc for more info.

To see a full list of attributes for each table, refer to Zopim's API documentation - click the name of the table to go there.

zopim_account
Primary Key: account_key

The zopim_account table contains information about your Zopim account.

Attributes include the widget key (account_key), creation date, status, plan details, and billing information.

zopim_agents
Primary Key: _id

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

Attributes include the agent ID (id), first and last name, display name, last login, login count, email, role, enabled setting, roles, and created at date.

  • zopim_agents__departments - This subtable contains data about the departments agents are associated with.

    The composite key for this table - made up of the agent ID and row ID - can be used to tie this table back to its parent, zopim_agents: _sdc_source_key_id: _sdc_level_0_id

zopim_banned_ips
Primary Key: _id

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

Attributes include the ban ID (id), type, reason, and IP address.

zopim_banned_visitors
Primary Key: _id

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

Attributes include the ban ID (id), type, visitor ID, visitor name, IP address, and reason.

zopim_chats
Primary Key: _id

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

There can be many attributes in this table depending on the type of chat (support vs. offline). Please refer to Zopim’s documentation (linked in the table name above) for more info.

Subtables
The composite key for the following tables - made up of the chat ID and row ID - can be used to tie them back to their parent, zopim_chats: _sdc_source_key_id: _sdc_level_0_id

  • zopim_chats__agent_ids - This subtable contains the IDs of the agents that were involved in the chat.
  • zopim_chats__agent_names - This subtable contains the names of the agents that were involved in the chat.
  • zopim_chats__history - This subtable contains the individual messages that were in the chat.
  • zopim_chats__webpath - This subtable contains info about the pages the customer navigated to during the chat.

zopim_departments
Primary Key: _id

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

Attributes include the department ID (id), name, description, enabled setting, and department-level settings.

  • zopim_departments__members - This subtable contains data about the members associated with a department.

    The composite key for this table - made up of the department ID and row ID - can be used to tie them back to their parent, zopim_departments: _sdc_source_key_id: _sdc_level_0_id

zopim_shortcuts
Primary Key: name

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

Attributes include the shortcut name (name), options, and message.

  • zopim_shortcuts__tags - This subtable contains data about the tags associated with a shortcut.

    The composite key for this table - made up of the shortcut ID and row ID - can be used to tie them back to their parent, zopim_shortcuts: _sdc_source_key_id: _sdc_level_0_id

zopim_triggers
Primary Key: name

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

Attributes include the trigger name (name), enabled setting, and description.

Related:

Was this article helpful?
0 out of 0 found this helpful

Comments

Questions or suggestions? If something in our documentation is unclear, let us know in the comments!