Zuora
:::warning
Deprecation notice
The Zuora source connector is scheduled for deprecation on 5 March 2024. It is incompatible with upcoming platform updates for Airbyte 1.0. After deprecation, the connector won’t be supported or available in Airbyte.
This connector doesn’t support the new per-stream features needed to protect data integrity during Airbyte synchronisation. Without these features, Airbyte can’t enforce its reliability and correctness standards for data syncing operations.
Recommended actions
To continue syncing this data, consider creating a custom connector as an alternative. For guidance, visit Custom Connector documentation.
:::
Sync overview
The Zuora source supports Full Refresh and Incremental syncs. You can copy only new or updated data with each sync. Alternatively, copy every row from the tables and columns you’ve configured for replication.
Airbyte uses REST API to fetch data from Zuora. The REST API accepts ZOQL (Zuora Object Query Language), a SQL-like language, to export the data.
Output schema
This source can sync:
- standard objects available in your Zuora Account
- custom objects you’ve manually added and that are available in your Zuora Account
- custom fields in standard and custom objects that are available in your Zuora Account
Discovering your Zuora Account object schema may take some time when you first add the connection. It may also take time when you refresh the available streams. Don’t cancel this operation while it runs. It usually takes 5-10 min, depending on the number of objects available in your Zuora Account.
Note
Some Zuora Objects may be unavailable for syncing because of Zuora Supscription Plan or Permissions limitations. See the Availability of Data Source Objects section in the Zuora documentation for details.
Data type mapping
| Integration Type | Airbyte Type | Notes |
|---|---|---|
decimal(22,9) | number | float number |
decimal | number | float number |
float | number | float number |
double | number | float number |
integer | number | |
int | number | |
bigint | number | |
smallint | number | |
timestamp | number | number representation of the unix timestamp |
date | string | |
datetime | string | |
timestamp with time zone | string | |
picklist | string | |
text | string | |
varchar | string | |
zoql | object | |
binary | object | |
json | object | |
xml | object | |
blob | object | |
list | array | |
array | array | |
boolean | boolean | |
bool | boolean |
Any data type not listed in the table above is treated as string.
Features
| Feature | Supported?(Yes/No) | Notes |
|---|---|---|
| Full Refresh Overwrite Sync | Yes | |
| Full Refresh Append Sync | Yes | |
| Incremental - Append Sync | Yes | |
| Incremental - Append + Deduplication Sync | Yes | |
| Namespaces | No |
Supported Zuora environments
| Environment | Supported?(Yes/No) | Notes |
|---|---|---|
| Production | Yes | Select from exising options while setup |
| Sandbox | Yes | Select from exising options while setup |
Supported data query options
| Option | Supported?(Yes/No) | Notes |
|---|---|---|
| LIVE | Yes | Run data queries against Zuora live transactional databases |
| UNLIMITED | Yes | Run data queries against an optimized, replicated database at 12 hours freshness for high volume extraction use cases (Early Adoption, additionall access required, contact Zuora Support in order to request this feature enabled for your account beforehand.) |
Supported Zuora environments
Production
| Environment | Endpoint |
|---|---|
| US Production | rest.zuora.com |
| US Cloud Production | rest.na.zuora.com |
| EU Production | rest.eu.zuora.com |
Sandbox
| Environment | Endpoint |
|---|---|
| US API Sandbox | rest.apisandbox.zuora.com |
| US Cloud API Sandbox | rest.sandbox.na.zuora.com |
| US Central Sandbox | rest.test.zuora.com |
| EU API Sandbox | rest.sandbox.eu.zuora.com |
| EU Central Sandbox | rest.test.eu.zuora.com |
Other
| Environment | Endpoint |
|---|---|
| US Performance Test | rest.pt1.zuora.com |
For more information about available environments, visit this page.
Performance considerations
If your sync takes a long time, consider these options:
- increase the
window_in_daysparameter in the Zuora source configuration - use a smaller date range by adjusting the
start_dateparameter
Note
The first sync for all objects in your Zuora Account usually takes 25-45-60 min. More data requires more time.
Get started
Create an API user role
- Log in to your
Zuora acccount. - In the Zuora dashboard’s top-right corner, select
Settings>Administration Settings. - Select
Manage User Roles. - Select
Add new roleto create a new role, then complete the required form fields.
Assign the role to a user
-
From the
administrationpage, selectManage Users. -
Select
add single user. -
Create a user and assign the role you created in the
Create an API user rolesection. -
You’ll receive an email with activation instructions. Follow them to activate your API user.
For more information, visit Create an API User page.
Create Client ID and Client Secret
-
From the
administrationpage, selectManage Users. -
Select the User Name of the target user.
-
Enter a client name and description, then select
create. -
A pop-up opens with your Client ID and Client Secret.
Save your Client ID and Client Secret because they won’t be shown again. You’ll need them to configure Airbyte Zuora Connector.
-
You can now set up Zuora connector in Airbyte using the created
Client IDandClient Secret.
IP allow list
If you use Airbyte Cloud and your organisation restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.1.3 | 2021-10-16 | 7093 | Added support of Unlimited option for Data Query |
| 0.1.2 | 2021-10-11 | 6960 | Change minimum value for Window_in_days to 1, instead of 30 |
| 0.1.1 | 2021-10-01 | 6575 | Added OAuth support for Airbyte Cloud |
| 0.1.0 | 2021-08-01 | 4661 | Initial release of Native Zuora connector for Airbyte |