Replicate Multiple Zendesk Accounts

Ready to get started?

Learn more or sign up for a free trial:

CData Sync



Replicate multiple Zendesk accounts to one or many databases.

CData Sync for Zendesk is a stand-alone application that provides solutions for a variety of replication scenarios such as replicating sandbox and production instances into your database. Both Sync for Windows and Sync for Java include a command-line interface (CLI) that makes it easy to manage multiple Zendesk connections. In this article we show how to use the CLI to replicate multiple Zendesk accounts.

Configure Zendesk Connections

You can save connection and email notification settings in an XML configuration file. To replicate multiple Zendesk accounts, use multiple configuration files. Below is an example configuration to replicate Zendesk to SQLite:

Windows

<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>System.Data.SQLite</DatabaseProvider> <ConnectionString>URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> <TaskSchedulerStartTime>09:51</TaskSchedulerStartTime> <TaskSchedulerInterval>Never</TaskSchedulerInterval> </CDataSync>

Java

<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>org.sqlite.JDBC</DatabaseProvider> <ConnectionString>URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> </CDataSync>

Connecting to Zendesk

To connect, set the URL and provide authentication. The URL is your Zendesk Support URL: https://{subdomain}.zendesk.com.

Authenticating to Zendesk

You can authenticate using the Basic or OAuth methods.

Using Basic Authentication

To use Basic authentication, specify your email address and password or your email address and an API token. Set User to your email address and follow the steps below to provide the Password or ApiToken.

  • Enable password access in the Zendesk Support admin interface at Admin > Channels > API.
  • Manage API tokens in the Zendesk Support Admin interface at Admin > Channels > API. More than one token can be active at the same time. Deleting a token deactivates it permanently.

Using OAuth Authentication

See the Getting Started guide in the CData driver documentation for an authentication guide.

Configure Queries for Each Zendesk Instance

Sync enables you to control replication with standard SQL. The REPLICATE statement is a high-level command that caches and maintains a table in your database. You can define any SELECT query supported by the Zendesk API. The statement below caches and incrementally updates a table of Zendesk data:

REPLICATE Tickets;

You can specify a file containing the replication queries you want to use to update a particular database. Separate replication statements with semicolons. The following options are useful if you are replicating multiple Zendesk accounts into the same database:

You can use a different table prefix in the REPLICATE SELECT statement:

REPLICATE PROD_Tickets SELECT * FROM Tickets

Alternatively, you can use a different schema:

REPLICATE PROD.Tickets SELECT * FROM Tickets

Run Sync

After you have configured the connection strings and replication queries, you can run Sync with the following command-line options:

Windows

ZendeskSync.exe -g MyProductionZendeskConfig.xml -f MyProductionZendeskSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar ZendeskSync.jar -g MyProductionZendeskConfig.xml -f MyProductionZendeskSync.sql