Skip to content

Latest commit

 

History

History
135 lines (99 loc) · 7.48 KB

zoho-crm.md

File metadata and controls

135 lines (99 loc) · 7.48 KB
Raw

Zoho CRM

Sync overview

The Zoho CRM source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.

Airbyte uses REST API to fetch data from Zoho CRM.

This Source Connector is based on an Airbyte CDK.

Output schema

This Source is capable of syncing:

  • standard modules available in Zoho CRM account
  • custom modules manually added by user, available in Zoho CRM account
  • custom fields in both standard and custom modules, available in Zoho CRM account

The discovering of Zoho CRM module schema is made dynamically based on Metadata API and should generally take no longer than 10 to 30 seconds.

Notes:

Some of Zoho CRM Modules may not be available for sync due to limitations of Zoho CRM Edition or permissions scope. For details refer to the Scopes section in the Zoho CRM documentation.

Connector streams and schemas are built dynamically on top of Metadata that is available from the REST API - please see Modules API, Modules Metadata API, Fields Metadata API. The list of available streams is the list of Modules as long as Module Metadata is available for each of them from the Zoho CRM API, and Fields Metadata is available for each of the fields. If a module you want to sync is not available from this connector, it's because the Zoho CRM API does not make it available.

Data type mapping

Integration Type Airbyte Type Notes
boolean boolean
double number
currency number
integer integer
profileimage string
picklist string enum
textarea string
website string format: uri
date string format: date
datetime string format: date-time
text string
phone string
bigint string airbyte_type: big_integer
event_reminder string
email string format: email
autonumber string airbyte_type: big_integer
jsonarray array
jsonobject object
multiselectpicklist array
lookup object
ownerlookup object
RRULE object
ALARM object

Any other data type not listed in the table above will be treated as string.

Features

Feature Supported? (Yes/No)
Full Refresh Overwrite Sync Yes
Full Refresh Append Sync Yes
Incremental - Append Sync Yes
Incremental - Append + Deduplication Sync Yes
Namespaces No

List of Supported Environments for Zoho CRM

Production

Environment Base URL
US https://zohoapis.com
AU https://zohoapis.com.au
EU https://zohoapis.eu
IN https://zohoapis.in
CN https://zohoapis.com.cn
JP https://zohoapis.jp

Sandbox

Environment Endpoint
US https://sandbox.zohoapis.com
AU https://sandbox.zohoapis.com.au
EU https://sandbox.zohoapis.eu
IN https://sandbox.zohoapis.in
CN https://sandbox.zohoapis.com.cn
JP https://sandbox.zohoapis.jp

Developer

Environment Endpoint
US https://developer.zohoapis.com
AU https://developer.zohoapis.com.au
EU https://developer.zohoapis.eu
IN https://developer.zohoapis.in
CN https://developer.zohoapis.com.cn
JP https://developer.zohoapis.jp

For more information about available environments, please visit this page

Performance considerations

Also, Zoho CRM API calls are associated with credits, each Zoho CRM edition has a limit in a 24-hour rolling window, so please, consider it when configuring your connections. More details about Zoho CRM API credit system can be found here.

Note about using the Zoho Developer Environment

The Zoho Developer environment API is inconsistent with production environment API. It contains about half of the modules supported in the production environment. Keep this in mind when pulling data from the Developer environment.

Setup Guide (Airbyte Open Source)

To set up a connection with a Zoho CRM source, you will need to choose start sync date, Zoho CRM edition, region and environment. The latest are described above. Except for those, you will need OAuth2.0 credentials - Client ID, Client Secret and Refresh Token.

Get Client ID, Client Secret, and Grant Token

  1. Log into https://api-console.zoho.com/
  2. Choose client
  3. Enter a scope the future refresh and access tokens will cover. For instance, it can be ZohoCRM.modules.ALL, ZohoCRM.settings.ALL, ZohoCRM.settings.modules.ALL. Make sure the scope covers all needed modules.
  4. Enter grant token's lifetime and description, click "Create".
  5. Copy Grant token, close the popup and copy Client ID and Client Secret on the "Client Secret" tab.

Create Refresh Token

For generating the refresh token, please refer to this page. Make sure to complete the auth flow quickly, as the initial token granted by Zoho CRM is only live for a few minutes before it can no longer be used to generate a refresh token.

Changelog

Version Date Pull Request Subject
0.1.0 2022-03-30 11193 Initial release