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.

Load Freshdesk Data to a Database Using Embulk



Use CData JDBC drivers with the open source ETL/ELT tool Embulk to load Freshdesk data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Freshdesk, Embulk easily loads data from Freshdesk to any supported destination. In this article, we explain how to use the CData JDBC Driver for Freshdesk in Embulk to load Freshdesk data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Freshdesk data. When you issue complex SQL queries to Freshdesk, the driver pushes supported SQL operations, like filters and aggregations, directly to Freshdesk and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to Freshdesk Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Freshdesk\lib).

Embulk supports JDBC connectivity, so you can easily connect to Freshdesk and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with 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 JDBC connection string for Freshdesk:

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

Load Freshdesk Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
  2. embulk gem install embulk-input-jdbc
  3. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load Freshdesk data into MySQL using Embulk.

Create a Job to Load Freshdesk Data

Start by creating a config file in Embulk, using a name like freshdesk-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for Freshdesk, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.freshdesk.FreshDeskDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (freshdesk-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.freshdesk.jar driver_class: cdata.jdbc.freshdesk.FreshDeskDriver url: jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey; table: "Tickets" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Tickets" mode: insert

After creating the file, run the Embulk job.

embulk run freshdesk-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Freshdesk Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.freshdesk.jar driver_class: cdata.jdbc.freshdesk.FreshDeskDriver url: jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey; query: "SELECT Id, Name FROM Tickets WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Tickets" mode: insert

More Information & Free Trial

By using CData JDBC Driver for Freshdesk as a connector, Embulk can integrate Freshdesk data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.