How to Query Respond.io Data in MySQL Workbench

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Execute MySQL queries against live Respond.io data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for Respond.io to query Respond.io data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Respond.io data in MySQL Workbench.

Connect to Respond.io 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.

Start by setting the Profile connection property to the location of the Respondio Profile on disk (e.g. C:\profiles\Respondio.apip). Next, set the ProfileSettings connection property to the connection string for Respondio (see below).

Respondio API Profile Settings

Respond.io uses API key authentication. To obtain an API key:

  1. Log in to your Respond.io account.
  2. Navigate to Settings in your workspace.
  3. Select Developer under the Integrations section.
  4. Copy the API key displayed on the page.

After obtaining your API key, set the following connection properties:

  • AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

  • APIKey: Set this to your Respond.io API key.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Respond.io 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.

Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Respond.io from MySQL Workbench

The steps below outline connecting to the virtual Respond.io database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Respond.io data.

Connect to Respond.io through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for Respond.io).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query Respond.io Data

  1. Open the connection you just created (CData SQL Gateway for Respond.io).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve Respond.io data, like SELECT * FROM `CData API Sys`.Contacts;

With access to live Respond.io data from MySQL Workbench, you can easily work with Respond.io, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.

Ready to get started?

Connect to live data from Respond.io with the API Driver

Connect to Respond.io