# Zoho CRM

This article outlines the integration with Zoho CRM connector, enabling metadata management through features such as crawling, and data preview. It also ensures secure authentication via Credential Manager.

<figure><img src="/files/4DylGfSWg0H2DfuOd0Zm" alt=""><figcaption></figcaption></figure>

### Overview

#### Connector Details

| Connector Category                                                           | Application Connector               |
| ---------------------------------------------------------------------------- | ----------------------------------- |
| OvalEdge Releases Supported                                                  | Release8.1                          |
| <p>Connectivity</p><p>\[How the connection is established with Zoho CRM]</p> | REST APIs (Oauth 2.0 refresh token) |
| Verified Zoho CRM  Version                                                   | Zoho CRM REST API v3.1              |

{% hint style="info" %}
The Zoho CRM connector has been validated with the mentioned "Verified Zoho CRM Versions" and is expected to be compatible with other supported Zoho CRM versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.
{% endhint %}

#### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |       ❌      |
| Query Sheet                                  |       ❌      |
| Data Preview                                 |       ✅      |
| Auto Lineage                                 |       ❌      |
| Manual Lineage                               |       ❌      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |       ❌      |
| DAM (Data Access Management)                 |       ❌      |
| Bridge                                       |       ✅      |

#### Metadata Mapping

The following objects are crawled from Zoho CRM and mapped to the corresponding UI assets.

| Zoho CRM Object | Zoho CRM Attribute | Object Type     | OvalEdge Asset      |
| --------------- | ------------------ | --------------- | ------------------- |
| Organization    | Organization ID    | Container       | Database for Tables |
| Module          | Module API Name    | Module / Entity | Table               |

### Set up a Connection

#### Prerequisites

The following are the prerequisites to establish a connection:

**Network and API Access**

The connector uses HTTPS (TCP port 443) to connect to Zoho Accounts for token refresh and Zoho CRM APIs. Allow outbound TLS access from the OvalEdge environment to the configured Zoho domains (such as the Zoho Accounts URL and CRM API URL). If you use a corporate proxy, ensure it allows HTTPS access to these endpoints.

{% hint style="warning" %}
If firewalls or proxies block Zoho OAuth or CRM API traffic, validation, crawling, and queries will fail. Ensure the required Zoho endpoints are allowed by your network team.
{% endhint %}

**Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
👨‍💻 Who can provide these permissions? These permissions are typically granted by the Zoho CRM administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Operation                  | Objects              | API/Scope                        | Access Permission                                                    |
| -------------------------- | -------------------- | -------------------------------- | -------------------------------------------------------------------- |
| Connection Validation      | Organization Details | Organization API                 | OAuth 2.0 token exchange and permission to read organization details |
| Crawling                   | Modules              | Settings - Module API            | Permission to read module metadata                                   |
| Crawling                   | Fields               | Settings - Fields API            | Permission to read field metadata per module                         |
| Query Sheet / Data Preview | Module Records       | Records API (versioned CRM path) | Permission to read records in module                                 |

#### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log into OvalEdge, go to **Administration > Connectors**, click **+ (New Connector)**, search for **Zoho CRM**, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="219.5999755859375">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "<strong>Zoho CRM</strong>" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Zoho CRM connection              </p><p>(<strong>Example</strong>: "Zoho_CRM").</p></td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Zoho Accounts Domain*</td><td>Enter the Zoho Accounts URL used for OAuth token refresh. <strong>Default</strong>: https://accounts.zoho.com</td></tr><tr><td>Client ID*</td><td>Enter the OAuth Client ID from the Zoho API Console</td></tr><tr><td>Client Secret*</td><td>Enter the OAuth Client Secret from the Zoho API Console</td></tr><tr><td>Refresh Token*</td><td>Enter the OAuth refresh token used to generate access tokens</td></tr><tr><td>API Domain</td><td><p>Enter the Zoho CRM API base URL.</p><p><strong>Default</strong>: https://api.zoho.com</p></td></tr><tr><td>API Version</td><td><p>Enter the Zoho CRM API version. </p><p><strong>Default</strong>: v3.1</p></td></tr><tr><td>Modules (Allowlist)</td><td><p>Enter module names (comma-separated) to limit crawling. </p><p>(<strong>Example:</strong> Leads, Accounts). Leave blank to crawl all modules</p></td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="277.199951171875"></th><th></th></tr></thead><tbody><tr><td><strong>Default Governance Roles</strong></td><td></td></tr><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.</td></tr><tr><td><strong>Admin Roles</strong></td><td></td></tr><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in OvalEdge Security are available for selection.</td></tr><tr><td><strong>No of Archive Objects</strong></td><td></td></tr><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr><tr><td><strong>Bridge</strong></td><td></td></tr><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.</p></td></tr></tbody></table>

{% hint style="info" %}
If Credential Manager is set to an external vault provider, secret fields can be presented as vault-key inputs, and a Credential Manager Connector ID may be required.
{% endhint %}

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

### Manage Connector Operations

#### Crawl/Profile

{% hint style="warning" %}
To perform crawl operations, users must be assigned the Integration Admin role.
{% endhint %}

The **Crawl/Profile** button allows users to select one or more schemas for **crawling**.&#x20;

1. Navigate to the **Connectors** page and click **Crawl/Profile**.
2. Select the **schemas** to **crawl**.
3. The **Crawl** option is selected by default.&#x20;
4. Click **Run** to collect metadata from the connected source and load it into the OvalEdge **Data Catalog**.
5. After a **successful crawl**, the information appears in the **Data Catalog > Databases/Tables/Reports/Files/APIs** tab.

The **Schedule** checkbox allows automated **crawling** at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the Select **Period drop-down**.
2. Select a **time period** for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the crawl operation at the scheduled time.

#### Other Operations

The **Connectors** page in OvalEdge provides a centralized view of all configured connectors, including their health status.

**Managing connectors includes:**

* **Connectors Health:** Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing:** Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.

**Nine Dots Menu Options:**

To view, edit, validate, configure, or delete connectors, click on the Nine Dots menu.

* **Edit Connector:** Update and revalidate the data source.
* **Validate Connector:** Check the connection's integrity.
* **Settings:** Modify connector settings.
  * **Crawler:** Configure data extraction.
  * **Access Instructions:** Add notes on how data can be accessed.
  * **Business Glossary Settings:** Manage term associations at the connector level.
* **Delete Connector:** Remove a connector with confirmation.

#### Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="89">S.No.</th><th width="262.5999755859375">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Invalid connection config.</td><td><p><strong>Error Description:</strong> </p><ul><li>Required connection details are missing.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Edit the connector settings and fill all mandatory fields.</li><li>Validate the connector again. </li></ul></td></tr><tr><td>2</td><td><p><br></p><p>Client ID is required.</p></td><td><p><strong>Error Description:</strong></p><ul><li>The database name provided is invalid.</li></ul><p><strong>Resolution:</strong></p><ul><li>Provided an incorrect database name in the setup form's Database Name field.</li><li>Ensure that the database name is correctly spelled and exists in the target system.</li></ul></td></tr><tr><td>3</td><td>Client Secret ID is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>The OAuth Client Secret is missing.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Enter the Client Secret from the Zoho API Console.</li></ul></td></tr><tr><td>4</td><td>Refresh Token is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>The refresh token is missing.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Generate and enter a valid refresh token with required CRM scopes.</li></ul></td></tr><tr><td>5</td><td>Zoho CRM connection validation failed.</td><td><p><strong>Error Description:</strong> </p><ul><li>Token refresh or organization access failed.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Verify the accounts domain, client credentials, refresh token, and permissions.</li></ul></td></tr><tr><td>6</td><td>Invalid request.</td><td><p><strong>Error Description:</strong> </p><ul><li>The request payload is incomplete or invalid.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Retry from the connector UI and ensure valid object selection.</li></ul></td></tr><tr><td>7</td><td>Unsupported entity type:</td><td><p><strong>Error Description:</strong> </p><ul><li>The selected object is not supported.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Run query or preview only on supported modules.</li></ul></td></tr><tr><td>8</td><td>Missing module name (entityId)</td><td><p><strong>Error Description:</strong> </p><ul><li>Module name is not provided.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Select a module before running query or data preview.</li></ul></td></tr><tr><td>9</td><td>No queryable fields found for module</td><td><p><strong>Error Description:</strong> </p><ul><li>No accessible fields are available for the module.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Check module permissions and retry crawling.</li></ul></td></tr></tbody></table>

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ovaledge.com/release8.1/connectors/connector-repositories/application/zoho-crm.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.