With our community of partners, you can get expert advice and training so you can be up and running in no time! SETUP PARTNERS

API Upgrade V3

Important changes to the WorkflowMax API coming soon. 

You’ll need to upgrade to API v3 to keep your connection live.

At Xero, we’re committed to protecting the data and privacy of our partners and customers. We take this responsibility very seriously and we’re constantly looking for ways to improve security across our platform and show best practice and leadership. 

We’ve been working closely with the Australian Tax Office (ATO) and groups like the Australian Business Software Industry Association (ABSIA) to help develop a new set of standards for digital services providers with add-on marketplaces. This important work has led us to review and update our own security standards and apply these globally from 6 April 2020. You can read more about what will be required here.

 

Here's what's changing for the WorkflowMax API 

To meet the new standards, we are upgrading the WorkflowMax API to v3. The new version will be available from 6 April 2020. You’ll need to update your connection by the deadline or the result will be a breaking change for anyone accessing the current version of the API. Deadlines depend on how you use the API and are explained in each link below.

The WorkflowMax API (WFM API) has been split to manage business connections and practice connections, and there will be more stringent security requirements. 

We have also created a new Xero Practice Manager API (XPM API) specifically for the accounting and bookkeeping channel. There is a different set of instructions and deadlines for those who want to access this new XPM API.

You will need to upgrade your existing API connection to either the WFM API, or the XPM API. If your app needs access to both, then you will need to create two connections for your WorkflowMax and Xero Practice Manager customers. 

There are also authentication and URL changes which you will need to make to complete the upgrade.

 

What you need to do

To find out what you need to do by when and how these changes will affect you, click the link (or links) that best describes how you connect via the API to your account.

 

WFM user of an app I don’t own

Example: I connect my WorkflowMax account with one or more apps like Deputy and Receipt Bank.

See instructions

 

WFM developer of an app others connect to 

Example: I’m a developer and I’ve created an app for small businesses that integrates with WorkflowMax, like Better Scheduling.

See instructions

 

WFM bespoke, generic key, or 1:1 integrations

Example: I’m a WFM user who paid for a bespoke integration between my WFM account and another application I own, for instance my WFM account and a marketing website.

See instructions