Connect to Zendesk Data in NetBeans

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!



Connect to Zendesk data in NetBeans with the data source configuration wizard.

The CData JDBC Driver for Zendesk integrates connectivity to live Zendesk data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Zendesk data in NetBeans. You will create a connection and edit and save Zendesk data in the Table Editor.

Create a JDBC Data Source for Zendesk in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

  • Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.zendesk.jar file. The driver JAR is located in the lib subfolder of the installation directory.
  • Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.zendesk.ZendeskDriver from the menu.
  • Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

  1. In the Service window, right-click the Database node and click New Connection.

  2. In the New Connection Wizard, enter the following connection properties:

    • Driver Name: In the menu, select the CData JDBC Driver for Zendesk.
    • User Name: Enter the username. This can also be defined in the JDBC URL.
    • Password: Enter the password. This can also be defined in the JDBC URL.
    • JDBC URL: Specify 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 the following:

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

Query Zendesk Data

To connect to Zendesk data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data. You can also insert, update, or delete records in the Data Views window.