Skip to main content

Zoho Data Source

Follow the instructions below to create a new data flow that ingests data from a Zoho source in Nexla.
zoho_api.png

Zoho

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Zoho connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Zoho instance, and click Next; or, create a new Zoho credential for use in this flow.

  3. In Nexla, Zoho data sources can be created using pre-built endpoint templates, which expedite source setup for common Zoho endpoints. Each template is designed specifically for the corresponding Zoho endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

Zoho sources can also be configured manually, allowing you to ingest data from Zoho endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
• To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Zoho endpoints. Each template is designed specifically for the corresponding Zoho endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get All Accounts

    This endpoint template gets a list of all available accounts from your Zoho CRM account. Use this template when you need to access account information, account data, or account metadata for analysis, reporting, or integration purposes. Check out the API documentation link to view details about Account record structure.

    • This endpoint automatically retrieves all accounts from your Zoho CRM account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses page-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of account data.

    This endpoint returns all accounts from your Zoho CRM account, including account IDs, names, descriptions, and other account metadata. The endpoint uses page-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of account data.

    For detailed information about accounts, API response structures, pagination, and available account data, see the Zoho CRM API documentation.

    Get All Leads

    This endpoint template gets a list of all available leads from your Zoho CRM account. Use this template when you need to access lead information, lead data, or lead metadata for analysis, reporting, or integration purposes. Check out the API documentation link to view details about Lead record structure.

    • This endpoint automatically retrieves all leads from your Zoho CRM account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses page-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of lead data.

    This endpoint returns all leads from your Zoho CRM account, including lead IDs, names, email addresses, phone numbers, and other lead metadata. The endpoint uses page-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of lead data.

    For detailed information about leads, API response structures, pagination, and available lead data, see the Zoho CRM API documentation.

    Get All Contacts

    This endpoint template gets a list of all available contacts from your Zoho CRM account. Use this template when you need to access contact information, contact data, or contact metadata for analysis, reporting, or integration purposes. Check out the API documentation link to view details about Contact record structure.

    • This endpoint automatically retrieves all contacts from your Zoho CRM account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses page-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of contact data.

    This endpoint returns all contacts from your Zoho CRM account, including contact IDs, names, email addresses, phone numbers, and other contact metadata. The endpoint uses page-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of contact data.

    For detailed information about contacts, API response structures, pagination, and available contact data, see the Zoho CRM API documentation.

    Get All Cases

    This endpoint template gets a list of all available cases from your Zoho CRM account. Use this template when you need to access case information, case data, or case metadata for analysis, reporting, or integration purposes. Check out the API documentation link to view details about Case record structure.

    • This endpoint automatically retrieves all cases from your Zoho CRM account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses page-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of case data.

    This endpoint returns all cases from your Zoho CRM account, including case IDs, subjects, descriptions, statuses, and other case metadata. The endpoint uses page-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of case data.

    For detailed information about cases, API response structures, pagination, and available case data, see the Zoho CRM API documentation.

    Get All Invoices

    This endpoint template gets a list of all available invoices from your Zoho CRM account. Use this template when you need to access invoice information, invoice data, or invoice metadata for analysis, reporting, or integration purposes. Check out the API documentation link to view details about Invoice record structure.

    • This endpoint automatically retrieves all invoices from your Zoho CRM account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses page-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of invoice data.

    This endpoint returns all invoices from your Zoho CRM account, including invoice IDs, numbers, amounts, dates, and other invoice metadata. The endpoint uses page-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of invoice data.

    For detailed information about invoices, API response structures, pagination, and available invoice data, see the Zoho CRM API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Zoho data sources can be manually configured to ingest data from any valid Zoho CRM API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Zoho sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Zoho CRM API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API (most common for Zoho data sources)

API Endpoint URL​

  1. Enter the URL of the Zoho CRM API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Zoho CRM API endpoints typically follow the pattern {api_domain}/crm/v2/{module_name} where {api_domain} is your Zoho API domain (e.g., https://www.zohoapis.com) and {module_name} is the module name (e.g., Accounts, Leads, Contacts).

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires OAuth 2.0 authentication via the Authorization header, which is handled automatically by your credential configuration.

Path to Data​

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch a list of accounts, the API will typically return an array of account records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when Zoho CRM API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data[*] to access an array of records within a response object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/record to access record elements within a data element).

    Path to Data Example:

    If the Zoho CRM API response is in JSON format and includes a nested array named data that contains the relevant data, the path to the response would be entered as $.data[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Endpoint Testing (Manual Configuration)​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Zoho data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.