Connect to Zendesk Data in CloverDX (formerly CloverETL)

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Zendesk JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Zendesk including Tickets, Groups, Users, Schedules, and more!



Transfer Zendesk data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Zendesk enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Zendesk as sources and destinations. In this article, you will use the JDBC Driver for Zendesk to set up a simple transfer into a flat file. The CData JDBC Driver for Zendesk enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Zendesk as sources and destinations. In this article, you will use the JDBC Driver for Zendesk to set up a simple transfer into a flat file.

Connect to Zendesk as a JDBC Data Source

  1. Create the connection to Zendesk data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.zendesk.jar file.
  3. Enter the JDBC URL.

    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.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Zendesk JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.zendesk.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    A typical JDBC URL is below:

    jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;InitiateOAuth=GETANDREFRESH

Query Zendesk Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Zendesk JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Id, Subject FROM Tickets

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Tickets table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.