Query Xero WorkflowMax Data as a MySQL Database in Node.js

Ready to get started?

Learn more or sign up for a free trial:

CData Connect



Execute MySQL queries against Xero WorkflowMax data from Node.js.

You can use CData Connect Cloud to query Xero WorkflowMax data through a MySQL interface. Follow the procedure below to create a virtual database for Xero WorkflowMax in Connect Cloud and start querying using Node.js.

CData Connect Cloud provides a pure MySQL, cloud-to-cloud interface for Xero WorkflowMax, allowing you to easily query live Xero WorkflowMax data in Node.js — without replicating the data to a natively supported database. As you query data in Node.js, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc) directly to Xero WorkflowMax, leveraging server-side processing to quickly return Xero WorkflowMax data.

Create a Virtual MySQL Database for Xero WorkflowMax Data

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Connect Cloud and click Databases.
  2. Select "Xero WorkflowMax" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to Xero WorkflowMax.

    To connect to the WorkflowMax API, obtain an APIKey and AccountKey from Xero. This can only be done by contacting Xero support (https://www.workflowmax.com/contact-us).

    After obtaining an API Key and Account Key, set the values in the APIKey and AccountKey connection properties. Once these are set, you are ready to connect.

  4. Click Test Database.
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Xero WorkflowMax data from any MySQL client.

Query Xero WorkflowMax from Node.js

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

  • Host name, or address, and port: The address of your instance of the Connect Cloud (myinstance.cdatacloud.net) and the port (3306)
  • Username and password: The username and password of a user you authorized on Connect Cloud
  • Database name: The database you configured for Xero WorkflowMax (workflowmaxdb)

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

var mysql      = require('mysql');
var fs         = require('fs');
var connection = mysql.createConnection({
  host     : 'myinstance.cdatacloud.net',
  database : 'workflowmaxdb',
  port	   : '3306',
  user     : 'admin',
  password : 'password',
  ssl      : {
    ca : fs.readFileSync('C:/certs/myCA.pem')
  }
});
connection.connect();
connection.query('SELECT * FROM Clients', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();