Ready to get started?

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

 Download Now

Learn more:

Freshdesk Icon Freshdesk JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Freshdesk.

Connect to Freshdesk Data in CloverDX (formerly CloverETL)



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

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

Connect to Freshdesk as a JDBC Data Source

  1. Create the connection to Freshdesk 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.freshdesk.jar file.
  3. Enter the JDBC URL.

    FreshDesk makes use of basic authentication. To connect to data, set the following connection properties:

    • Domain: Set this to the domain associated with your FreshDesk account. For example, in your URL: https://my_domain.freshdesk.com.
    • APIKey: Set this to the API key associated with your FreshDesk account. To retrieve your API key, Log into your support Portal -> Click on profile picture in the top right corner -> profile settings page. The API key will be available below the change password section to the right.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.freshdesk.jar

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

    A typical JDBC URL is below:

    jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;

Query Freshdesk 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 Freshdesk JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Id, Name FROM Tickets WHERE Status = '2'

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.