Ready to get started?

Download a free trial of the Zendesk Driver to get started:

 Download Now

Learn more:

Zendesk Icon Zendesk JDBC Driver

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

Validate Zendesk Data with QuerySurge



Access and validate Zendesk data in QuerySurge using the CData JDBC Driver.

QuerySurge is a smart data testing solution that automates data validation and testing. When paired with the CData JDBC Driver for Zendesk, QuerySurge can work with live Zendesk data. This article walks through connecting to Zendesk data from QuerySurge.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Zendesk data. When you issue complex SQL queries to Zendesk, the driver pushes supported SQL operations, like filters and aggregations, directly to Zendesk and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Zendesk data using native data types.

Connecting to Zendesk Data in QuerySurge

To connect to live Zendesk data from QuerySurge, you need to deploy the JDBC Driver JAR file to your QuerySurge Agent(s) and add a new connection from the QuerySurge Admin view.

Deploy the JDBC Driver

  1. Download the CData JDBC Driver for Zendesk installer, unzip the package, and run the JAR file to install the driver.
  2. Once the driver is installed, stop the Agent Service.
  3. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for Zendesk\lib\) to your Agent(s) (QuerySurge_install_dir\agent\jdbc).
  4. Restart the Agent Service.

For more information on deploying JDBC drivers for QuerySurge, refer to the QuerySurge Knowledge Base.

Configure a New Connection to Zendesk

  1. Log into QuerySurge and navigate to the Admin view.
  2. Click Configuration -> Connections in the Administration Tree.
  3. Click Add to create a new connection.
  4. In the QuerySurge Connection Wizard, click Next.
  5. Name the connection (e.g. CData JDBC Connection to Zendesk).
  6. Set the Data Source to "All Other JDBC Connections (Connection Extensibility)" and click Next.
  7. Set the Driver Class to cdata.jdbc.zendesk.ZendeskDriver and click Next.
  8. Set the Connection URL using the necessary connection properties to authenticate with Zendesk. Your Connection URL will look something like the following:

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

    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.

    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.

  9. Set the Test Query to enable the Test Connection button for the Connection (e.g. SELECT * FROM Tickets LIMIT 1) and click Next.
  10. Click Test Connection to ensure the connection is configured properly and click Save to add the connection.

Once the connection is added, you can write SQL queries against your Zendesk data in QuerySurge.

Compare Zendesk Data Queries with a QueryPair

With the connection configured, you can follow the steps below to compare querying Zendesk data with a QueryPair.

  1. Select "Design Library" from the Design Menu
  2. Click QueryPairs under QuerySurge Design
  3. Click "Create New QueryPair"
  4. Name the QueryPair and click Save
  5. In either the Source or Target panes, select the connection created above (select the same connection to query Zendesk twice or another connection to perform a comparison)
  6. Write queries in the Editor for each pane, e.g. SELECT * FROM Tickets
  7. Click the "Design-Time Run" tab to execute the queries
  8. When the query execution is finished, click "View Query Results" to see the Zendesk data returned by the query

Download a free, 30-day trial of the CData JDBC Driver for Zendesk and start working with your live Zendesk data in QuerySurge. Reach out to our Support Team if you have any questions.