Ready to get started?

Learn more about the CData ODBC Driver for Freshdesk or download a free trial:

Download Now

Connect to Freshdesk Data in Ruby

Connect to Freshdesk data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

The CData ODBC Driver for Freshdesk makes it easy to integrate connectivity to live Freshdesk data in Ruby. This article shows how to create a simple Ruby app that connects to Freshdesk data, executes a query, and displays the results.

Create an ODBC Connection to Freshdesk Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Installing Ruby and Necessary Gems

If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:

gem install dbi gem install dbd-odbc gem install ruby-odbc

Create a Ruby App with Connectivity to Freshdesk Data

Create a new Ruby file (for example: FreshDeskSelect.rb) and open it in a text editor. Copy the following code into your file:

#connect to the DSN require 'DBI' cnxn = DBI.connect('DBI:ODBC:CData FreshDesk Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Id, Name FROM Tickets WHERE Status = '2'") #display the names of the columns resultSet.column_names.each do |name| print name, "\t" end puts #display the results while row = resultSet.fetch do (0..resultSet.column_names.size - 1).each do |n| print row[n], "\t" end puts end resultSet.finish #close the connection cnxn.disconnect if cnxn

With the file completed, you are ready to display your Freshdesk data with Ruby. To do so, simply run your file from the command line:

ruby FreshDeskSelect.rb Writing SQL-92 queries to Freshdesk allows you to quickly and easily incorporate Freshdesk data into your own Ruby applications. Download a free trial today!