Zoho CRM connector reference
This feature is in Beta. To use it, a workspace admin must turn on Lakeflow Connect for Zoho CRM from the Previews page. See Manage Databricks previews.
This page has reference information for the managed Zoho CRM connector, including supported source tables and destination table schemas.
Supported source tables
The Zoho CRM connector supports the following source tables, all under the default source schema:
Source table | Primary key | Description | Sync mode | Cursor field |
|---|---|---|---|---|
|
| Lead records. | Incremental |
|
|
| Contact records. | Incremental |
|
|
| Account records. | Incremental |
|
|
| Deal records. | Incremental |
|
|
| Campaign records. | Incremental |
|
|
| Task activity records. | Incremental |
|
|
| Call activity records. | Incremental |
|
|
| Meeting and event activity records. | Incremental |
|
|
| Notes attached to records. | Incremental |
|
|
| Vendor records. | Incremental |
|
|
| Quote records. | Incremental |
|
|
| Sales order records. | Incremental |
|
|
| Purchase order records. | Incremental |
|
|
| Solution records. | Incremental |
|
|
| Case records. | Incremental |
|
|
| Invoice records. | Incremental |
|
|
| Product records. | Incremental |
|
|
| Stage history entries for deals. | Incremental |
|
Custom module tables |
| One table per custom module that Zoho CRM reports as API-supported and viewable. Each table name is the module's API name in lowercase. | Incremental |
|
|
| Price book records. | Incremental |
|
|
| Line items on invoices. | Incremental |
|
|
| Line items on quotes. | Incremental |
|
|
| Line items on sales orders. | Incremental |
|
|
| Line items on purchase orders. | Incremental |
|
|
| Roles in the organization's role hierarchy. | Full refresh only | |
|
| User profiles. | Full refresh only | |
|
| Currencies configured for the organization. | Full refresh only | |
|
| Organization details. | Full refresh only | |
|
| Contact roles available for deals. | Full refresh only | |
|
| Territories configured in Territory Management. | Full refresh only | |
|
| Users in the organization. | Incremental |
|
|
| Deal stages for each pipeline and layout. | Full refresh only | |
|
| Tags defined for each module. | Incremental |
|
|
| Attachment metadata for records. | Incremental |
|
|
| Territories assigned to each user. | Full refresh only |
Connector options
For usage, see Examples.
Option | Type | Scope | Required | Applies to | Description |
|---|---|---|---|---|---|
| String | Pipeline | Yes | All incremental tables | Earliest date and time from which to ingest data, in |
Automatic data transformations
For module tables, item tables, and custom module tables, Databricks transforms Zoho CRM field types to Delta-compatible data types as follows. Each field type shows the Zoho CRM UI name where one applies, followed by its data_type value in the Zoho CRM fields metadata API.
Zoho CRM field type | Delta type |
|---|---|
Single Line ( | String |
Multi Line ( | String |
Email ( | String |
Phone ( | String |
Website ( | String |
Pick List ( | String |
| Array of strings ( |
Auto Number ( | String |
Profile Image ( | String |
| BigInt |
Long Integer ( | BigInt, or String when the API returns the value as a string |
Decimal ( | Double |
| Double |
Currency ( | Decimal(19, 4) |
| Decimal(19, 4) |
| Boolean |
| Date |
| Timestamp |
Formula ( | Based on the formula's return type: Double ( |
Rollup Summary ( | Based on the return type: Double ( |
Lookup ( | Variant |
Owner ( | Variant |
User ( | Variant |
| Variant |
Multi-Select Lookup ( | Variant |
Multi-User Lookup ( | Variant |
Subform ( | Variant |
File Upload ( | Variant |
Image Upload ( | Variant |
Address ( | Variant |
| Variant |
| Variant |
| Variant |
| Variant |
Destination table schemas
Module tables and custom module tables
The connector builds the schema of each module table, item table, and custom module table from that module's field metadata in Zoho CRM. Each field becomes a column named with the field's API name, and the column's data type follows Automatic data transformations. Columns therefore include custom fields and vary by Zoho CRM organization. Every table also has an id column of type STRING.
These tables are leads, contacts, accounts, deals, campaigns, tasks, calls, events, notes, vendors, quotes, sales_orders, purchase_orders, solutions, cases, invoices, products, deal_history, price_books, invoiced_items, quoted_items, ordered_items_sales_order, purchase_items, and attachments.
The connector creates one custom module table for each custom module that Zoho CRM reports as API-supported and viewable to the connection user. The table name is the module's API name in lowercase. For example, a custom module with the API name Projects lands in the projects table.
Primary key: id
Cursor field: Modified_Time
Tables with VARIANT columns don't support slowly changing dimension (SCD) type 2. Most module tables have lookup fields, such as the record owner, that map to VARIANT.
roles
Primary key: id
Sync mode: Full refresh only
Field | Data type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
profiles
Primary key: id
Sync mode: Full refresh only
Field | Data type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
currencies
Primary key: id
Sync mode: Full refresh only
Availability: Requires Multi-Currency, which is available in Professional edition or above.
Field | Data type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
organization
Primary key: id
Sync mode: Full refresh only
Field | Data type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
contact_roles
Primary key: id
Sync mode: Full refresh only
Field | Data type |
|---|---|
|
|
|
|
|
|
territories
Primary key: id
Sync mode: Full refresh only
Availability: Requires Territory Management, which is available in Enterprise edition or above.
Field | Data type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This table does not support SCD type 2 because it has VARIANT columns.
users
Primary key: id
Cursor field: Modified_Time
Field | Data type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This table does not support SCD type 2 because it has VARIANT columns.
stages
Primary key: layout_id, pipeline_id, id
Sync mode: Full refresh only
Field | Data type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
tags
Primary key: id
Cursor field: modified_time
Field | Data type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
user_territories
Primary key: user_id, id
Sync mode: Full refresh only
Availability: Requires Territory Management, which is available in Enterprise edition or above.
Field | Data type |
|---|---|
|
|
|
|
|
|
|
|
|
|
Required OAuth permissions
The connector requests the following read-only OAuth scopes for the Zoho Self Client. For more information, see Zoho CRM OAuth scopes.
Permission | Required for |
|---|---|
| Module tables, item tables, custom module tables, |
|
|
| Module tables, item tables, custom module tables |
| Custom module discovery, |
| Schema discovery for module tables, item tables, and custom module tables |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|