Kaizen 223 - File Manager in CRM Widget Using ZRC Methods

Hello, CRM Wizards!

Here is what we are improving this week with Kaizen. 

we will explore the new ZRC (Zoho Request Client) introduced in Widget SDK v1.5, and learn how to use it to build a Related List Widget that integrates with Zoho WorkDrive. It helps users to preview and upload files directly from the record’s detail page.

Why ZRC?

ZRC is a unified client for making REST calls across all developer-facing components in Zoho CRM. It is currently supported in Widgets and CScript, and will soon be available for other features within the Developer Hub as well.

It simplifies external API usage with:

1. async/await support
2. Auto JSON parsing
3. Unified API client for Zoho CRM developer tools (currently supported for CScript and widgets)
4. Stronger error handling
   

Business Problem

Zylker, a real-estate company, stores documents, images, and property videos for each lead in a third-party cloud storage platform. 

However, some of these files exceed 20 MB, making the CRM’s built-in file upload field unsuitable. Their team also needs the ability to preview and upload files directly from the Lead detail page.

Solution Overview

Zylker can build a Related List Widget integrated with their third-party cloud storage platform using ZRC methods.

This widget will allow users to:

1. Fetch and display files inside the folder linked to the Lead.
2. Preview files (images, PDFs, videos) inside the widget.
3. Upload new documents to the same folder.
4. Create new subfolders to keep the data organized. 
5. Navigate subfolders using breadcrumbs. 

To keep the demo simple, let us walk you through on building this widget for listing, previewing and uploading files using Zoho WorkDrive. 

Prerequisites

1. Create a Custom Field

Create a Single Line field named WorkDrive Folder ID in the Leads module. Check out the Working with Custom Fields document for guidance.

This stores the folder ID created for each lead through workflow rule that we build in the next steps.

2. Create WorkDrive and CRM Connection

1. Go to Setup > Developer Hub > Connections and click Create Connection. 
2. Choose Zoho WorkDrive with the scopes WorkDrive.files.CREATE and WorkDrive.files.READ. 
3. Click the Create and Connect button and proceed to authorize the connection.
   

1. Similarly, choose Zoho CRM with the ZohoCRM.modules.ALL scope and create the connection.

Refer to the Connections help doc for more information. Store the Connection Link Name to use while making API calls. 

3. Automate WorkDrive Folder Creation

1. Go to Automation > Workflow Rules in the Setup page and click Create Rule. 
2. Create a Workflow Rule with the following details:

Module: Leads

Trigger: On Record Creation

Condition: All Records

Action: Custom Action (Deluge Function)

Function Logic:

1. Create a new folder in the WorkDrive combining the lead's record ID and First Name as the folder's name. Use the Invoke URL task to make the Create Folder API call. 

responseMap = Map(); attributeInfo = Map(); dataInfo = Map(); headerMap = Map(); headerMap.put("Accept","application/vnd.api+json"); // First Name and Record ID from the argument AttributeInfo.put("name",Name + recordId); // Parent folder ID under which you want to maintain the lead folders attributeInfo.put("parent_id","e8gn06f2d7b3a48044090b7217524be95c9ac"); dataInfo.put("attributes",attributeInfo); dataInfo.put("type","files"); responseMap.put("data",dataInfo); folderCreateResponse = invokeurl [ url :"https://zohoapis.in/workdrive/api/v1/files" type :POST parameters:responseMap.toString() headers:headerMap         connection:"workdrive_oauth_connection" // Connection Link Name created in the prerequisites   ]; info folderCreateResponse;

2. Retrieve the folder ID from the API response.

3. Update the Lead’s WorkDrive Folder ID field with this folder ID using Update Records API call. 

requestBody = Map(); dataList = List(); record = Map(); // Set field values record.put("WorkDrive_Folder_ID",driveId); // Add record to list dataList.add(record); // Wrap data requestBody.put("data",dataList); updateLead = invokeurl [ url :"https://zohoapis.in/crm/v8/Leads/" + recordId type :PUT parameters:requestBody.toString() connection:"crm_oauth_connection" ]; info updateLead;

Assign values to the arguments using merge fields while associating the function with Workflow Rule.

Now every Lead has its own WorkDrive folder before the widget loads. 

Note:

The complete code snippet for the deluge function is attached to the post for your reference. 

Building the Related List Widget

Step 1: Initialize the Widget Project

Review the basics from our earlier Kaizen on CLI Installation, Creating a Widget Project, and Internal hosting of the same.

Step 2: Develop your Widget

After setting up the widget project using CLI, implement the following code logic for the case we are discussing:

1. Get the current record's ID from the PageLoad event. 
2. With the record ID, fetch the lead details using the GET Records API call using the GET ZRC method as shown here. 
   

// data.Entity and data.EntitiyId are the module and record ID from PageLoad const response = await zrc.get(       "/crm/v8/" + data.Entity + "/" + data.EntityId     );  var workdriveFolderId = response.data.data[0].WorkDrive_Folder_ID;

1. Extract the WorkDrive Folder ID from the response to get the list of files from the folder. 
2. Since we'll be using WorkDrive APIs multiple times, let’s create a reusable instance with the Connection Link Name and API's base URL. This way, we avoid repeating the same setup for every API call.

Following is sample of how to create a custom instance:

workDriveZrc = zrc.createInstance({     baseUrl: "https://www.zohoapis.in/workdrive/api/v1",     connection: "workdrive_oauth_connection",  });

You can also check out the Create Instance in the requestConfig help section to learn more. 

1. Now, let us make the GET List of Files/Folder API call using the newly created ZRC instance.  
   

let apiResponse = await workDriveZrc.get(         "/files/" + workdriveFolderId + "/files",         {           headers: {             Accept: "application/vnd.api+json",           },         }  );

1. Display the file details like File Name, Type and Modified Time in a table from the API response. Save the File ID in a variable for displaying preview. 
2. When user clicks a particular file, use the file ID to fetch the preview URL using the GET Preview Meta Data API. Then load the preview URL in an iframe to display the file. 
   

try {       const previewResponse = await workDriveZrc.get(         "/files/" + resourceId + "/previewinfo",         {           headers: {             Accept: "application/vnd.api+json",           },         }       );       parsed = JSON.parse(previewResponse.data);       console.log("Preview Data:", parsed);       // Extract the preview_url from the expected location       previewUrl = parsed && parsed.data && parsed.data.attributes && parsed.data.attributes.preview_url || null;       // Remove surrounding quotes if server wrapped the url in quotes       if (typeof previewUrl === "string") {         previewUrl = previewUrl.replace(/^"(.*)"$/, "$1").trim();       }     } catch (err) {       console.error("Error fetching preview info for resource:", resourceId, err);  } function showPreview(previewUrl, fileName, permalink) {   var modal = document.getElementById("modal-container");   var thumbnailFrame = document.getElementById("thumbnail-img");   var caption = document.getElementById("caption");   var workdriveLink = document.querySelector(".redirect-workdrive");   // Load the preview URL into the iframe   thumbnailFrame.src = previewUrl;   // Set the file name in caption and workdrive link   caption.textContent = fileName;   workdriveLink.setAttribute("data-link", permalink);   // Show the modal   modal.style.display = "block"; }

1. Create an Upload button for users to select files from their local. Convert the streamed files to blob and execute Upload API call using the custom ZRC instance. 
   

async function workdriveUpload(file, fileType, fileName, folderId) {   const fileBlob = new Blob([file], { type: fileType });   try {     const formData = new FormData();     formData.append("filename", fileName);     formData.append("parent_id", String(folderId).trim());     formData.append("content", fileBlob);     const uploadResponse = await workDriveZrc.post(       "/upload", formData,       {         headers: {           "Content-Type": "multipart/form-data",         },       }     );     console.log("Upload response:", uploadResponse.data);     return uploadResponse;   }   catch (error) {     console.error("Error uploading file:", error);     throw error;    } }

Step 3: Validate and Pack

Follow the steps given in the Widget help page to validate and package the widget.

Step 4: Upload to Zoho CRM

1. Go to Zoho CRM > Setup > Developer Hub > Widgets and click Create New Widget.
   

1. Fill in the required details such as:

Name: Zoho WorkDrive

Type: Related List 

Hosting: Zoho 

File Upload: Upload the ZIP created in the dist folder within the widget project directory after packaging in the Step 3. 

Index page: /widget.html

1. Create a related list in the Leads module and associate this widget. Refer to the Customize Related Lists help page for more information on creating a related list.
   

Try it Out!

A complete working code sample of this widget is attached at the bottom of this post for reference. 

Now let us see how this works from the Lead's detail page:

1. Listing the available files from Zoho WorkDrive on page load. 

2. Uploading new files to the folder.

3. Previewing all the listed files.

We hope this Kaizen helps you explore the new ZRC capabilities and build seamless file-management experiences in Zoho CRM.

Have questions or suggestions? Drop them in the comments or write to us at  support@zohocrm.com. 

We will circle back to you next Friday with another interesting topic. 

On to Better Building!

------------------------------------------------------------------------------------------------------

Related Reading

1. Widgets - An Overview, CLI Installation, Working with Widgets, ZRC Methods, Mobile Compatibility of Widgets and Kaizens 

2. Connections - An Overview

3. Functions - An Overview, Setting up Functions and Deluge

4. CRM APIs - GET Records and Update Records 

5. WorkDrive APIs - Upload Files, GET Preview Metadata, GET List of Files/Folder and Create Folder

6. CRM Customizations - Related Lists and Custom Fields.

------------------------------------------------------------------------------------------------------

Previous Kaizen: Client Script Support for Notes Related List | Kaizen Collection: Home

• Topic Participants

• Kiruthiga G

  

• Sticky Posts

• Kaizen #222 - Client Script Support for Notes Related List

  Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore how

• Kaizen #217 - Actions APIs : Tasks

  Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.

• Kaizen #216 - Actions APIs : Email Notifications

  Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are

• Kaizen #152 - Client Script Support for the new Canvas Record Forms

  Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved

• Kaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script

  Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.

• Recent Topics

• Why does Zoho’s diff viewer highlight parts of unchanged lines?

  Hi everyone, I’ve noticed something odd in the Zoho editor’s diff view. When I delete a single line, the diff doesn’t just mark that line as removed. Instead, it highlights parts of the next line as if they changed, even though they are identical. Example:

• CRM x WorkDrive: File storage for new CRM signups is now powered by WorkDrive

  Availability Editions: All DCs: All Release plan: Released for new signups in all DCs. It will be enabled for existing users in a phased manner in the upcoming months. Help documentation: Documents in Zoho CRM Manage folders in Documents tab Manage files

• Introducing Assemblies and Kits in Zoho Inventory

  Hello customers, We’re excited to share a major revamp to Zoho Inventory that brings both clarity and flexibility to your inventory management experience! Presenting Assemblies and Kits We’re thrilled to introduce Assemblies and Kits, which replaces the

• Automating Employee Birthday Notifications in Zoho Cliq

  Have you ever missed a birthday and felt like the office Grinch? Fear not, the Cliq Developer Platform has got your back! With Zoho Cliq's Schedulers, you can be the office party-cipant who never forgets a single cake, balloon, or awkward rendition of

• Zoho Survey reminder settings are extremely confusing

  Hi, I just want to set 3 reminders, one week apart from the first email out. Your form is too confusing and I don't understand. Can you simplify and be more specific regarding the language used on the form ?

• Add deluge function to shorten URLs

  Zoho Social contains a nice feature to shorten URLs using zurl.co. It would be really helpful to have similar functionality in a Deluge call please, either as an inbuilt function or a standard integration. My Creator app sends an email with a personalised

• form data load issue when saving as duplicate record is made

  Hello. I have a form with a lookup when a value is selected the data from the corresponding record is filled into all of the fields in the form. But the form is loaded in such a state that if any value is changed it will take all of the values pre loaded

• Recurring Tasks and Reminders in Projects

  Recurring tasks are tasks that are created once, and then recreated automatically after a designated time period. For example, the invoice for your billable tasks is due every week. You can set that task to recreate itself every week. Also, the future

• Unable to remove the “Automatically Assigned” territory from existing records

  Hello Zoho Community Team, We are currently using Territory Management in Zoho CRM and have encountered an issue with automatically assigned territories on Account records. Once any account is created the territory is assigned automatically, the Automatically

• Google Fonts Integration in Pagesense Popup Editor

  Hello Zoho Pagesense Team, We hope you're doing well. We’d like to submit a feature request to enhance Zoho Pagesense’s popup editor with Google Fonts support. Current Limitation: Currently, Pagesense offers a limited set of default fonts. Google Fonts

• Improved Contact Sync flow in Google Integration with Zoho CRM

  Hello Everyone, Your contact sync in Google integration just got revamped! We have redesigned the sync process to give users more control over what data flows into Google and ensure that this data flows effortlessly between Zoho CRM and Google. With this

• Improved Functionality PO Bill SO Invoice

  Hello, I need to enter over 100 items, it's frustrating to scroll a few item rows and wait for more to load, then scroll again. It would be nice to have buttons that scroll to the top or bottom with one click. Furthermore, these items I'm adding are VAT

• Wishes for 2026

  Hello, and a happy new year 2026! Let's hope it's better for everyone. I'd like to share some thoughts on Zoho One and what could be useful in the short, medium, and long term. Some things are already there, but not applied to Zoho One. Others seem like

• How to Integrate Zoho Books with Xero (No Native Connection Available)

  Hi everyone, I’m currently facing an issue with integrating Zoho Books invoices with Xero, as I’ve noticed Zoho does not provide a native integration with Xero at this time. I would like to ask: What are the common or recommended solutions for syncing

• error while listing mails

  I can't access email in any of my folders: Oops, an error occurred - retry produces the second error response: error while listing mails (cannot parse null string). I've signed in and out of Zoho, restarted my iMac.

• Ability to Edit YouTube Video Title, Description & Thumbnail After Publishing

  Hi Zoho Social Team, How are you? We would like to request an enhancement to Zoho Social that enables users to edit YouTube video details after the video has already been published. Your team confirmed that while Zoho Social currently allows editing the

• Critical Issue: Tickets Opened for Zoho Support via the Zoho Help Portal Were Not Processed

  Hi everyone, We want to bring to your attention a serious issue we’ve experienced with the Zoho support Help Portal. For more than a week, tickets submitted directly via the Help Portal were not being handled at all. At the same time no alert was posted

• Hide/Show Subform Fields On User Input

  Hello, Are there any future updates in Hide/Show Subform Fields "On User Input"?

• Cloning Item With Images Or The Option With Images

  Hello, when I clone an item, I expect the images to carry over to the cloned item, however this is not the case in Inventory. Please make it possible for the images to get cloned or at least can we get a pop up asking if we want to clone the images as

• Custom validation in CRM schema

  Validation rules in CRM layouts work nicely, good docs by @Kiran Karthik P https://help.zoho.com/portal/en/kb/crm/customize-crm-account/validation-rules/articles/create-validation-rules I'd prefer validating data input 'closer to the schema'

• Adding Default Module Image into mail merge field

  As with most people finding their way to these forums i have a specific requirement that doesn't seem to be supported by Zoho I have created 2 custom modules to suit my purpose 1 is an inventory type module that lists aluminium extrusions, and all relevant

• Is it possible to roll up all Contact emails to the Account view?

  Is there a way to track all emails associated with an Account in one single view? Currently, email history is visible when opening an individual Contact record. However, since multiple Contacts are often associated with a single Account, it would be beneficial

• Free Training - Explore What’s New in Zoho One 2025

  Greetings! We hope you have all had a chance by now to get hands-on with the new features and updates released as part of ZO25. Yes, we understand that you may have questions and feedback. To ensure you gain a comprehensive understanding of these updates,

• Good news! Calendar in Zoho CRM gets a face lift

  Dear Customers, We are delighted to unveil the revamped calendar UI in Zoho CRM. With a complete visual overhaul aligned with CRM for Everyone, the calendar now offers a more intuitive and flexible scheduling experience. What’s new? Distinguish activities

• Quick way to add a field in Chat Window

  I want to add Company Field in chat window to lessen the irrelevant users in sending chat and set them in mind that we are dealing with companies. I request that it will be as easy as possible like just ticking it then typing the label then connecting

• How to create a two way Sync with CRM Contacts Module?

  Newbie creator here (but not to Zoho CRM). I want to create an app that operates on a sub-set of CRM Contacts - only those with a specific tag. I want the app records to mirror the tagged contacts in CRM. I would like it to update when the Creator app

• Zoho Sheet for Desktop

  Does Zoho plans to develop a Desktop version of Sheet that installs on the computer like was done with Writer?

• How to import data from PDF into Zoho Sheet

  I am looking to import Consolidated Account Statement (https://www.camsonline.com/Investors/Statements/Consolidated-Account-Statement) into zoho sheet. Any help is appreciated. The pdf is received as attachment in the email, this document is password

• Zoho Projects Android app: Integration with Microsoft Intune

  Hello everyone! We’re excited to announce that Zoho Projects now integrates with Microsoft Intune, enabling enhanced security and enterprise app management. We have now added support for Microsoft Intune Mobile Application Management (MAM) policies through

• Cant't update custom field when custom field is external lookup in Zoho Books

  Hello I use that : po = zoho.books.updateRecord("purchaseorders",XXXX,purchaseorder_id,updateCustomFieldseMap,"el_books_connection"); c_f_Map2 = Map(); c_f_Map2.put("label","EL ORDER ID"); c_f_Map2.put("value",el_order_id); c_f_List.add(c_f_Map2); updateCustomFieldseMap

• About Zoneminder (CCTV) and Zoho People

  Hi team I would like to implement a CCTV service for our branches, with the aim of passively detecting both the entry and exit of personnel enrolled in Zoho Peeple, but my question is: It is possible to integrate Zoho People with Zoneminder, I understand

• Admin asked me for Backend Details when I wanted to verify my ZeptoMail Account

  Please provide the backend details where you will be adding the SMTP/API information of ZeptoMail Who knows what this means?

• Kaizen #223 - File Manager in CRM Widget Using ZRC Methods

  Hello, CRM Wizards! Here is what we are improving this week with Kaizen. we will explore the new ZRC (Zoho Request Client) introduced in Widget SDK v1.5, and learn how to use it to build a Related List Widget that integrates with Zoho WorkDrive. It helps

• Set connection link name from variable in invokeurl

  Hi, guys. How to set in parameter "connection" a variable, instead of a string. connectionLinkName = manager.get('connectionLinkName').toString(); response = invokeurl [ url :"https://www.googleapis.com/calendar/v3/freeBusy" type :POST parameters:requestParams.toString()

• Possible to connect Zoho CRM's Sandbox with Zoho Creator's Sandbox?

  We are making some big changes on our CRM so we are testing it out in CRM's Sandbox. We also have a Zoho Creator app that we need to test. Is it possible to connect Zoho CRM's Sandbox to Zoho Creator's Sandbox so that I can perform those tests?

• I Need Help Verifying Ownership of My Zoho Help Desk on Google Search Console

  I added my Zoho desk portal to Google Search Console, but since i do not have access to the html code of my theme, i could not verify ownership of my portal on Google search console. I want you to help me place the html code given to me from Google search

• Timeline Tracker

  Hi Team, I am currently using Zoho Creator – Blueprint Workflows, and I would like to know if there is a way to track a timeline of the approval process within a Blueprint. Specifically, I am looking for details such as: Who submitted the record Who clicked

• Primary / Other Billing Contacts

  If you add an additional contact to a Zoho Billing Customer record, and then mark this new contact as the primary contact, will both the new primary and old primary still receive notifications? Can you stop notifications from going to the additional contacts

• Is it possible to enforce a single default task for all users in a Zoho Projects ?

  In Zoho Projects, the Tasks module provides multiple views, including List, Gantt, and Kanban. Additionally, users can create and switch to their own custom views. During project review meetings, this flexibility creates confusion because different users

• [Free Webinar] Zoho Creator webinars - Learning Table and Creator Tech Connect Series in 2026

  Hello everyone, Wishing you all a wonderful new year! May 2026 and the years ahead bring more opportunities, growth, and learning your way 🙂 We’re excited to kick off the 2026 edition of the Learning Table Series and Creator Tech Connect Series ! Learning

• Next Page