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

  

• Doug Tereba

• Jaya Suriya J

  

• Sticky Posts

• Kaizen #198: Using Client Script for Custom Validation in Blueprint

  Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.

• Kaizen #226: Using ZRC in Client Script

  Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In this

• 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

• Recent Topics

• Restrict portal signup until registration form and payment are completed

  Hi everyone, I am working on a Zoho Creator portal for a project. In our business flow, users must first fill out a registration form and pay a registration fee before they are allowed to access the portal. However, when I share the portal link, users

• Zoho Creator In-App Notification

  Hi Team, I have implemented an in-app notification using code, as it required some customization. I followed the example in the link below: https://www.zoho.com/deluge/help/pushnotify-using-deluge.html#Example I have a couple of questions regarding this

• Tip #64- Exploring Technician Console: Screenshot- 'Insider Insights'

  Hello Zoho Assist Community! Have you ever needed to capture exactly what's happening on a remote machine, whether to document an issue, guide a customer, or keep a record of your session? That's where the Screenshot feature in Zoho Assist comes in! With

• Relating Invoices to Projects

  Hi Zoho team, If I have already created previously an invoice in Books, so I want to know how can I associate it with a relevant project? Thank you

• Create a quote/estimate that includes a range of prices

  I am interested in using Zoho Books' Quote templates to create estimates for my customers. I do a mix of fixed-bid quotes and quotes based on an hourly rate. For the hourly rate quotes/estimates, I like to include a price range, for example: 2-4 labor

• Budget

  I have just upgraded to the standard plan in order to be able to utilize the budgeting function and record budget amount

• Capirec bank Automatic feed update

  Can anyone tell me if Zoho supports Automatic bank feed update from a Capitec bank account in south africa?

• Free webinar! Accelerate deals with Zoho Sign for Zoho CRM and Bigin by Zoho CRM

  Hello, Paperwork shouldn’t slow you down. Whether you’re growing a small business or running a large enterprise, manual approvals and slow document turnaround can cost you time and revenue. With Zoho Sign for Zoho CRM and Bigin by Zoho CRM, you can take

• Add Lookup Field in Tasks Module

  Hello, I have a need to add a Lookup field in addition to the ones that are already there in the Tasks module. I've seen this thread and so understand that the reason lookup fields may not be part of it is that there are already links to the tables (

• 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

• Upload own Background Image and set Camera to 16:9

  Hi, in all known online meeting tools, I can set up a background image reflecting our corporate design. This doesn't work in Cliq. Additionally, Cliq detects our cameras as 4:3, showing black bars on the right and left sides during the meeting. Where

• 【まだ間に合う！】Zoho ユーザー交流会 | AI活用・CRM・Analytics の事例を聞いて、ユーザー同士で交流しよう！

  ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 3月27日(金)に東京、新橋で開催する「東京 Zoho ユーザー交流会 NEXUS」へのお申し込みがまだの方は、この機会にぜひお申し込みください！（参加無料） ーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーー イベントの詳細はこちらから▷▷ https://www.zohomeetups.com/tokyo2026vol1#/?affl=communityforumpost3 ーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーー

• ZeptoMail API

  Hello Since today, we experience issues with the ZeptoMail API. When trying to send e-mails using: https://api.zeptomail.eu/v1.1/email we receive the error: (503) Site unavailable due to a traffic surge. Please try again shortly. I kindly ask you to identify

• Sender Email Configuration Error.

  Hello Team, Hope you are all doing well. We are in the process of creating the Zoho FSM environment in the UAE. When we try to add the sender email address “techsupportuae@stryker.com”, we receive the error message: “Error occurred while sending mail

• Managing user mailbox actions

  An organization often has users with different roles and responsibilities, such as leadership, operations, or support teams. While some users may require full access to email features, others may only need limited functionality. For example, enabling

• Custom function return type

  Hi, How do I create a custom deluge function in Zoho CRM that returns a string? e.g. Setup->Workflow->Custom Functions->Configure->Write own During create or edit of the function I don't see a way to change the default 'void' to anything else. Adding

• Update P_Leave: code: 7052 "Employee_ID": "Enter Employee ID"

  Hi, Zoho People - Update Leaves Can someone assist? ------------------------------------------------------------------------------------------ col = Collection(); col.insert("recordid":id); col.insert("Date_Check_Approval":zoho.currentdate); info zoho.people.update("P_Leave",col.toMap());

• Prevent tracking users from specific countries

  Currently, I’m receiving many bot visits from the United States and Malaysia. I would like these visits not to be recorded in SalesIQ. I already enabled the option to exclude traffic from cloud service providers, but I’m still receiving bot visits. Ideally,

• Es posible cambiar el lenguaje de los modulos del ASAP?

  Es posible cambiar el lenguaje de estos textos? Tengo Zoho configurado en español pero aun así me muestra estos textos en ingles:

• Using workflows to automatically set classification of new tickets

  Hello, I am trying to use a workflow to set a classification for a new ticket that is created via an email coming into my desk department. The workflow is working fine if I create a ticket from within desk, however if a ticket is emailed in then this

• Text/SMS With Zoho Desk

  Hi Guys- Considering using SMS to get faster responses from customers that we are helping.  Have a bunch of questions; 1) Which provider is better ClickaTell or Screen Magic.  Screen Magic seems easier to setup, but appears to be 2x as expensive for United States.  I cannot find the sender id for Clickatell to even complete the configuration. 2) Can customer's reply to text messages?  If so are responses linked back to the zoho ticket?  If not, how are you handling this, a simple "DO NOT REPLY" as

• Default/Private Departments in Zoho Desk

  1) How does one configure a department to be private? 2) Also, how does one change the default department? 1) On the list of my company's Zoho Departments, I see that we have a default department, but I am unable to choose which department should be default. 2) From the Zoho documentation I see that in order to create a private department, one should uncheck "Display in customer portal" on the Add Department screen. However, is there a way to change this setting after the department has been created?

• Show unsubscribed contacts ?

  Hello, I would like to display the unsubscribed contacts. Unfortunately, I do not have this subscription type as described in the documentation (https://help.zoho.com/portal/en/kb/marketing-automation-2-0/user-guide/contacts/contact-management/articles/subscription-type-24-1-2024#Subscription_Type_field.)

• What's New in Zoho Inventory | Q2 2025

  Hello Customers, The second quarter have been exciting months for Zoho Inventory! We’ve introduced impactful new features and enhancements to help you manage inventory operations with even greater precision and control. While we have many more exciting

• "Spreadsheet Mode" for Fast Bulk Edits

  One of the challenges with using Zoho Inventory is when bulk edits need to be done via the UI, and each value that needs to be changed is different. A very common use case here is price changes. Often, a price increase will need to be implemented, and

• 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

• ZOHO BOOKS - RECEIVING MORE ITEMS THAN ORDERED

  Hello, When trying to enter a vendor's bill that contains items with bigger quantity than ordered in the PO (it happens quite often) - The system would not let us save the bill and show this error: "Quantity recorded cannot be more than quantity ordered." 

• Stock count by bin location

  Is there a configuration to make a stock count by bin or area and not by product. these is useful to manage count by area Regards

• Server-based Appication API access for Social, Sites, Flow, Pages.

  Hello, I am trying to hook up API access for a number of apps and I have hit a wall trying to add these scopes to the API feed. We cannot find the correct way to list the scope for these Zoho apps; Social, Sites, Flow, Writer. Error on web-page comes

• Zoho Survey – Page Skip Logic Not Working

  Hi everyone, I'm experiencing an issue with the page skip logic in Zoho Survey. Last week, it was working fine, and I haven’t changed anything in the settings. However, today the skip logic is not working at all. I also tried testing it with different

• Zoho Survey: Bulk Exporting Raw Data (CSV/Excel) from 100+ Individual Survey Projects

  Hi Zoho Community, I am currently managing a 360-degree evaluation process that involves 100+ individual survey projects (one separate survey for each employee being evaluated). I need to download the raw response data (CSV or Excel) for all 100 surveys.

• Brand Studio Projects in Analytics

  Hi All, Currently pulling my hair out over trying to link together some social media posts for a reporting dashboard in Analytics, so I thought I'd see if anyone on here had a solution. Our Marketing Team created a LinkedIn campaign in Zoho Brand Studio,

• ERROR: Product type cannot be changed for Items having transactions.

  I have mistakenly added a product type as goods for an item that was a digital service. Now when HSN/SAC became mandatory, this brought my attention to this error I did. So I tried changing the product type but it displayed this error message Product

• Combine and hide invoice lines

  In quickbooks we are able to create a invoice line that combines and hides invoices lines below. eg. Brochure design         $1000 (total of lines below, the client can see this line) Graphic Design           $600 (hidden but entered to reporting and

• Introducing Built-in Telephony in Zoho Recruit

  We’re excited to introduce Built-in Telephony in Zoho Recruit, designed to make recruiter–candidate communication faster, simpler, and fully traceable. These capabilities help you reduce app switching, handle inbound calls efficiently, and keep every

• Include Notes in email templates for task

  Hi there,  I am setting up some automated email reminders via "setup-automation-workflow" to be send out when a task is being edited. I would like to include the "task notes" in the email. Is that possible? I do not find that field in the dropdown table when setting up the email template. Is it also possible to trigger the workflow rule when a new note is added to the task? In my opinion that should be quite essential, since a task update is often done by adding a new note to the task.... Also i

• Auto-publish job openings on my Zoho Recruit Careers Website

  I have developed a script using the Zoho Recruit API that successfully inserts new jobOpening records to my Zoho Recruit website, but my goal is to auto-publish to the Careers Website. The jobOpening field data shows two possible candidates to make this

• [Free webinar] Custom domains for portals in Zoho Creator - Creator Tech Connect

  Hello everyone, We’re excited to invite you to another edition of the Creator Tech Connect webinar. About Creator Tech Connect The Creator Tech Connect series is a free monthly webinar featuring in-depth technical sessions designed for developers, administrators,

• Remove my video

  Hi, How can I remove my video so that I don't have to see myself. It's weird so I always remove my own video from what I see but cannot find this feature here. Thanks!

• Marking a meeting 'done'.

  I would like to somehow mark a meeting 'done' and placed under the contact's page rather than deleting it and having no record of it. Am I missing a button that does this?

• Next Page