Connect to Zendesk Data in DBeaver

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!



Manage Zendesk data with visual tools in DBeaver like the query browser.

The CData JDBC Driver for Zendesk implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Zendesk data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Zendesk Data

Follow the steps below to load the driver JAR in DBeaver.

  1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
  2. In the Driver Name box, enter a user-friendly name for the driver.
  3. To add the .jar, click Add File.
  4. In the create new driver dialog that appears, select the cdata.jdbc.zendesk.jar file, located in the lib subfolder of the installation directory.
  5. Click the Find Class button and select the ZendeskDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.zendesk.ZendeskDriver.
  6. Add jdbc:zendesk: in the URL Template field.

Create a Connection to Zendesk Data

Follow the steps below to add credentials and other required connection properties.

  1. In the Databases menu, click New Connection.
  2. In the Create new connection wizard that results, select the driver.
  3. On the next page of the wizard, click the driver properties tab.
  4. Enter values for authentication credentials and other properties required to connect to Zendesk.

    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.

    Below is a typical connection string:

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

Query Zendesk Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.