Connect to Freshdesk Data in DBeaver

The CData JDBC Driver for Freshdesk 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 Freshdesk data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Freshdesk 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.freshdesk.jar file, located in the lib subfolder of the installation directory.
5. Click the Find Class button and select the FreshDeskDriver 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.freshdesk.FreshDeskDriver.
6. Add jdbc:freshdesk: in the URL Template field.

Create a Connection to Freshdesk 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 Freshdesk.

   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.

   Below is a typical connection string:

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

Query Freshdesk 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.