Xero Connector Configuration Guide
The Xero Connector in Rayven.io integrates directly with Xero’s Accounting API, allowing you to manage accounts, bank transactions, and contacts from within your workflows.
What It Does
-
Connects to Xero’s API to retrieve and update financial data.
-
Automates workflows involving accounts, transactions, and contact management.
-
Uses secure OAuth 2.0 authentication with Xero.
-
Supports both real-time triggers and scheduled data retrieval.
How to Use
Rayven Workflow Implementation
-
Obtain Xero API Access
-
Sign in to Xero Developer Portal.
-
Create a new app and generate your OAuth 2.0 access token (Xero Authentication Docs).
-
-
Add Xero Credentials in Rayven
-
Go to Settings → Credentials in Rayven.io.
-
Add your Access Token and save.
-
-
Add Xero Nodes to Your Workflow
-
From Input Nodes, select a preconfigured Xero operation such as Accounts List or Retrieve Bank Transactions.
-
-
Configure & Test
-
Set the API URL and parameters (if any).
-
Test to confirm data retrieval or updates work as expected.
-
Preconfigured Xero Endpoints
| Endpoint Name | Description | Type | API Documentation |
|---|---|---|---|
| Accounts List | Retrieve a list of all accounts within your Xero organization. | Input | Accounts API |
| Update Account | Update an existing account’s details. | Output | Update Account |
| Retrieve Bank Transactions | Get all bank transactions for your Xero organization. | Input | Bank Transactions API |
| Create Contact | Add a new contact to Xero. | Output | Create Contact |
| Get Contact | Retrieve details of a specific contact. | Input | Get Contact |
| Get All Contacts | List all contacts in your Xero organization. | Input | List Contacts |
| Update Contact | Modify an existing contact’s details. | Output | Update Contact |
Configuration Fields
| Field | Requirement | Description |
|---|---|---|
| Node Name* | Required | Internal name for the node. |
| Endpoint | Required | The specific Xero API operation to use (e.g., Accounts List). |
| API URL* | Required | Xero API endpoint URL for the selected operation. |
| Access Token | Required | Xero OAuth 2.0 access token for authentication. |
| Trigger | Optional | Enable to run the node on a schedule or event. |
| Interval Between Trigger Events | Optional | Time gap between automated trigger executions. |
| Interval Units | Optional | Measurement units for the trigger interval (e.g., seconds, minutes, hours, days). |
| Activation | Optional | Enable or disable the node in the workflow. |
| Trigger Using Filter | Optional | Run the node only when specific conditions are met. |
| Logical Operand* | Optional | Logical operator (e.g., AND, OR) for combining filter conditions. |
| Select Data Source Filter* | Optional | Filter definition for narrowing retrieved data. |
Adding Custom Endpoints
If your needed operation is missing:
-
Use the HTTP Request Node
-
Select Xero as the credential type.
-
Provide:
-
API endpoint URL (Xero API Docs)
-
HTTP method (GET, POST, PUT, DELETE)
-
Headers and payload as required.
-
-
-
Request a New Endpoint from Rayven Support
-
Provide the Xero API method name and required parameters.
-
Most requests are added within 72 hours.
-
Authentication
| Method | Notes |
|---|---|
| OAuth 2.0 Access Token | Required for all operations. Obtained from the Xero Developer Portal when creating your app. |
Best Practices
-
Use scoped access tokens to limit permissions.
-
Refresh tokens before expiration to avoid workflow interruptions (Token Refresh Docs).
-
Apply filters to reduce large data retrievals.
-
Test with a Xero demo company before production.
Use Cases
-
Automating bank transaction imports into Rayven dashboards.
-
Keeping customer contact lists synced between Xero and other systems.
-
Generating automated reports of account balances.
-
Triggering alerts for specific financial events.
FAQ (Chatbot Q&A Layer)
Q: What operations can I perform with the Xero Connector?
A: Accounts management, bank transaction retrieval, and contact management.
Q: How do I authenticate?
A: Use an OAuth 2.0 Access Token from the Xero Developer Portal.
Q: Can I use Xero APIs not listed here?
A: Yes — use the HTTP Request Node.
Q: Does the connector support data updates as well as retrieval?
A: Yes — certain endpoints (e.g., Update Account, Update Contact) allow updates.
Q: Can I schedule regular data imports from Xero?
A: Yes — enable triggers with intervals.