​
Setup Guide

You can find your Xero app credentials by visiting your Xero Developer Portal

Note: You’ll need to create a new Xero app if you don’t already have one.

You’ll need the following information to set up your Xero App with Paragon Connect:

  • Client ID
  • Client Secret
  • Scopes Requested

​
Add the Redirect URL to your Xero app

Paragon provides a redirect URL to send information to your Xero app. To add the redirect URL to your Xero app:

  1. Copy the link under “Redirect URL” in your integration settings in Paragon. The Redirect URL is:
https://passport.useparagon.com/oauth

  1. Log in to your Xero Developer Portal.

  2. Select your application from the developer portal.

  3. Under App details > OAuth 2.0 credentials, press the Add another URI button.

  4. Paste-in the redirect URL from Paragon. The redirect URL can be found in Step 1.

  5. Press the Save button to save the Redirect URL.

​
Add your Xero app to Paragon

  1. Select Xero from the Integrations Catalog.

  2. Under Integrations > Connected Integrations > Xero > Settings, fill out your credentials in their respective sections:

  • Client ID:

    1. Log in to your Xero Developer Portal.

    2. Select your application.

    3. Navigate to App details > OAuth 2.0 credentials.

    4. Copy the Client ID from “Client id”.

  • Client Secret:

    1. Log in to your Xero Developer Portal.

    2. Select your application.

    3. Navigate to App details > OAuth 2.0 credentials.

    4. Press Generate a secret.

    5. Copy the Client Secret to use in Paragon.

  • Permissions: Select the scopes you’ve requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. View dashboard.

Press the blue “Connect” button to save your credentials.

Note: Leaving the Client ID and Client Secret blank will use Paragon development keys.

​
Connecting to Xero

Once your users have connected their Xero account, you can use the Paragon SDK to access the Xero API on behalf of connected users.

See the Xero REST API documentation for their full API reference.

Any Xero API endpoints can be accessed with the Paragon SDK as shown in this example.

JavaScript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Query Payments
await paragon.request("xero", "payments", {
  method: "GET",
});

​
Building Xero workflows

Once your Xero account is connected, you can add steps to perform the following actions:

  • Get Accounts
  • Get Contacts
  • Create Customer
  • Update Customer
  • Get Invoices
  • Create Invoice
  • Update Invoice
  • Send Invoice
  • Get Payments
  • Create Payments

When creating or updating customers and invoices in Xero, you can reference data from previous steps by typing {{ to invoke the variable menu.

​
Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users’ Xero account. For example, you might want to trigger a workflow whenever new customers are created in Xero to sync your users’ Xero customers to your application in real-time.

You can find the full list of Webhook Triggers for Xero below:

  • New Account
  • New Customer
  • New Invoice