Xero Setup Guide

Follow our setup guide to connect Xero to Fivetran.

Prerequisites

To connect Xero to Fivetran, you need:

a Xero account with an Adviser or Standard user role
a Custom Connection subscription for your organization

Supported authentication methods

We support the following authentication methods for Xero connections:

Custom connection: We recommend using this authentication method for Xero organization in Australia (AU), New Zealand (NZ), UK (GB), and the United States (US).
Web app: Use this authentication method for Xero organizations located outside Australia (AU), New Zealand (NZ), UK (GB), and the United States (US).

The setup process varies based on the authentication method you want to use for your connection.

Setup instructions - Custom connection

This authentication method is supported only for Xero organisations in Australia, New Zealand, the United Kingdom, and the United States.

Create custom connection app

Log in to your Xero account.
In the top right corner, click New app.
Enter the Name of your application.
In the Integration type field, choose Custom connection.
In the Company or application URL field, enter your company URL.
Click Create app.

Configure app scopes

Go to the Configuration page.
In the Scopes drop-down menu, select the following API scopes for your app:
- accounting.settings.read
- accounting.transactions.read
- accounting.contacts.read
- accounting.journals.read
- payroll.employees.read
- payroll.payruns.read
- payroll.payslip.read
- payroll.timesheets.read
- payroll.settings.read
- assets.read
Click Save and connect. You will receive an authorization link in the email address associated with your Xero account.

Authorize custom connection

Open your email and click Connect to activate your custom connection.
In the drop-down menu, select the organization you want to connect with Xero and click Allow access.

Generate client secret

Log in to the Xero Developer Portal and select the custom connection app you created.
Click Configuration > Generate a secret.
Make a note of the Client ID and Client Secret. You will need them to configure Fivetran.

(Optional) Set up webhook

Webhooks allow us to capture all updates to the INVOICE table.

Expand to see the instructions

Find webhook URL

In the Fivetran dashboard, go to your Xero connection setup form.
Set the Use Webhook toggle to ON.
Make a note of the webhook URL.

Create webhook

In the Xero Developer Portal, select the custom connection app you created.
On the navigation menu, click Webhooks.
Select Billing subscriptions, Contacts, and Invoices.
In the Delivery URL field, enter the webhook URL you found.
Click Save.
Make a note of the Webhooks key. You will need it to configure Fivetran.

Finish Fivetran configuration

In the connection setup form, enter your Destination schema name.
Go to the Custom Connections tab.
Enter the Client ID and Client Secret.
(Optional) To enable a webhook for your connection, create a webhook in Xero and enter the Webhook Key you found.
Click Save & Test.

If you experience a post-sync error, click Edit Connection, re-enter the Client Secret, and re-authorize.

Setup instructions - Web app

If your Xero organization is based in Australia, New Zealand, the UK, or the US (United States), we recommend using a custom connection instead of a web app to authenticate your connection.

Create web app

Log in to your Xero account.
In the top right corner, click New app.
Enter the Name of your application.
In the Integration type field, choose Web app.
In the Company or application URL field, enter your company URL.
In the Redirect URI field, enter https://fivetran.com/integrations/xero/oauth2/return.
Click Create app.