Query Zendesk Data as a MySQL Database in Node.js

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.



Execute MySQL queries against Zendesk data from Node.js.

You can use the SQL Gateway from the ODBC Driver for Zendesk to query Zendesk data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.

Connect to Zendesk Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Zendesk data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Zendesk from Node.js

The following example shows how to define a connection and execute queries to Zendesk with the mysql module. You will need the following information:

  • Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
  • Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
  • Database name: The DSN you configured for the MySQL remoting service.

Connect to Zendesk data and start executing queries with the code below:

var mysql      = require('mysql');
var connection = mysql.createConnection({
  host     : 'localhost',
  database : 'CData Zendesk Sys',
  port	   : '3306',
  user     : 'mysql_user',
  password : 'test'
});
connection.connect();
connection.query('SELECT * FROM Tickets', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();