Connect to Zendesk Data in Ruby

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Zendesk ODBC Driver

The Zendesk ODBC Driver is a powerful tool that allows you to connect with live Zendesk project management data, directly from any applications that support ODBC connectivity.

Access Zendesk like you would a database - read, write, and update Tickets, Groups, Users, Schedules, etc. through a standard ODBC Driver interface.



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

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

Create an ODBC Connection to Zendesk 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.

Connecting to Zendesk

To connect, set the URL and provide authentication. The URL is your Zendesk Support URL: https://{subdomain}.zendesk.com.

Authenticating to Zendesk

You can authenticate using the Basic or OAuth methods.

Using Basic Authentication

To use Basic authentication, specify your email address and password or your email address and an API token. Set User to your email address and follow the steps below to provide the Password or ApiToken.

  • Enable password access in the Zendesk Support admin interface at Admin > Channels > API.
  • Manage API tokens in the Zendesk Support Admin interface at Admin > Channels > API. More than one token can be active at the same time. Deleting a token deactivates it permanently.

Using OAuth Authentication

See the Getting Started guide in the CData driver documentation for an authentication guide.

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 Zendesk Data

Create a new Ruby file (for example: ZendeskSelect.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 Zendesk Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Id, Subject FROM Tickets") #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 Zendesk data with Ruby. To do so, simply run your file from the command line:

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