How to connect to Freshdesk Data from IntelliJ

The CData JDBC Driver for Freshdesk enables you to access Freshdesk as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Freshdesk data in IntelliJ.

Create a JBDC Data Source for Freshdesk

Follow the steps below to add the driver JAR and define connection properties required to connect to Freshdesk data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.freshdesk.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.freshdesk.FreshDeskDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:freshdesk: and includes connection properties separated with semicolons.

     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 the following:

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

Edit and Save Freshdesk Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.