Building extensions #7: Create custom widgets for a simplified end-user experience

Building extensions #7: Create custom widgets for a simplified end-user experience

Discover the benefits of using widgets!

We explored the significance of widgets, prerequisites, and the availability of JS SDK methods as part of our previous post. In this post, let's go over a detailed example of using widgets along with certain Zoho Projects JS SDK methods.

Use case: A developer is working on a Zoho Projects task and wants to know if there are any existing references that could be used to get a head start on their work.

Goal: Our goal here is to simplify the developer's job by presenting them with articles that are relevant to the task at hand.

Solution: Widgets! To achieve this goal, it would be ideal for the developer to have access to relevant Zoho Desk articles from a tab on the Task Details page. This can be accomplished by developing a custom widget.

Required components:
  1. A connection between Zoho Projects and Zoho Desk.
  2. An extension configuration process that includes:
A. Creating an extension
B. Configuring the plugin manifest
C. Setting up the widget code to display the Zoho Desk articles on the Zoho Projects Task Details tab
We have already explored the steps to establish a connection, create an extension, and configure the plugin-manifest.json file as part of our earlier posts. You can refer to those resources for detailed guidance. In this case, we have already completed most of these steps (screenshots below).

1. Connection

We have created a connection to establish a secure integration between Zoho Projects and Zoho Desk.



2. Extension Configuration
A. Extension creation: We have created a new extension for Zoho Projects.



B. Plugin-manifest.json configuration: Once the extension is created, we next configure the plugin-manifest.json file to include the created connection and a widget.
For our extension use case, the plugin-manifest.json file is configured as shown in the below screenshot.



C. Setting up the widget code:
Now that we have the connection established, the extension created, and the plugin-manifest.json configured, let's go ahead and set up the custom widget code to achieve our goal.

Index.html - Widget code

<!DOCTYPE html>
<html>
<head>
<title>App Default Screen</title>
<style>
div.a {
line-height: 200%;
}
</style>
</head>
<body>
<div class="a">
<ul id="demo" style="font-size:20px"> <b>Article Details</b></ul>
</div>
</body>
<script>
var subject = "";
Util = {};
zohoprojects.init().then(function() {
//Fetching the task subject using the Zoho Projects JS SDK method
zohoprojects.get("task.name").then(function(response) {
subject = response.data;
var articledetails = {
type: "GET",
headers: {
"orgId": "xxxxxxx",
"Content-Type": "application/json"
}
};
//Using the request JS SDK method to invoke and get the Desk articles matching the task subject 
using the connection
zohoprojects.request(url, articledetails, "zohodeskforlistingarticles").then(function(response) {
var list = document.getElementById('demo');
var a = document.createElement("a");
var result = response.result;
var data = result.data;
//Looping through the articles
for (i = 0; i < data.length; i++) {
var title = data[i].title;
var author = data[i].author;
var authorname = author.name;
var weburl = data[i].webUrl;
var entry = document.createElement('li');
entry.innerHTML = title.link(weburl) + " by " + authorname;
list.appendChild(entry);
}
});
});
});
</script>
</html>
  • Here, we utilized the Zoho Projects JS SDK method to extract the task name, which is the task subject.
  • We then used the Zoho Projects Request method to invoke the Zoho Desk API to search for articles.
  • The Request method is used to make requests to third-party applications. It must be invoked with the belowparameters:
  • Third-party API URL: This is the URL of the third-party application's API that needs to be invoked. In our case, we need to fetch articles from Zoho Desk based on a search value, so we used the Zoho Desk Articles Search API. We've included a search query parameter in the API as the title of the help article (wildcard search), and we've set the value of the search query parameter (title) as the task's subject. As a result, the API will look for any Zoho Desk help articles that satisfy a wildcard match with the task subject.
  • Data object: Depending on the type of action being performed, each API requires a method type, body, header, and/or parameters to be invoked. To invoke the third-party application API, a data object with the necessary API details must be created. In our scenario, a header providing the Zoho Desk org ID is required to call the Zoho Desk article search API, which we have hardcoded.
  • Connection: To work on the data of a third-party application safely, we would need to connect to that application. The link name of the connection created for the third-party application is the value of the connection parameter. This value will be available in the JSON code generated when the third-party application connection is established. This connection allows you to invoke the Zoho Desk API securely.
  • Once the API is invoked by providing the necessary parameters for the Request method, the response for the invoked Zoho Desk search articles API is returned. We extract the information we require from the response, like the title, author name, and web URL. We then list and display this data in the Zoho Projects task details widget, Related Articles.
Sample output
  • Access your Zoho Projects portal and enter into a task.

  • Choose the Related Articles task tab, which is the widget we created.

  • The widget displays the available Zoho Desk articles that are related to the task at hand.

  • Finally, click on an article to view its detailed information in Zoho Desk.


Using this method, developers working on Zoho Projects tasks can discover relevant articles and get helpful information to troubleshoot problems.

You can further enhance this use case by including a text box in the widget that allows the developer to enter a keyword and search for related articles using the Zoho Desk search articles API.

You can also accomplish use cases such as creating a task tab widget to associate data with a task. Every time the task loads, task-specific data can be displayed on the Task tab. To accomplish these kind of use cases, the data storage feature is available in Zoho Projects. We look forward to exploring the data storage feature,, and other use cases for custom widgets, in future posts.

We hope you found this information useful. Follow this space for further updates!

Sign up for a Zoho Developer account and start developing extensions for Zoho products using Sigma.

SEE ALSO




        • Recent Topics

        • Unable to integrate Whatsapp Messaging into Zoho CRM - Business Messaging

          Hello, I want to set up Business Messaging in our Zoho CRM and am struggling to set it up. I have logged into the account and our facebook business page, our business shows in the dropdown for WhatsApp Business Account but does not for WhatsApp Business
        • Files in Teamspaces: keep your team's documents where the work happens

          Release Note: This feature is available for all accounts across all DCs Hello Everyone, A Teamspace is built around a specific team and a shared objective, and it holds the modules and projects that team works with every day. The document that team depends
        • Script to access a CBPX file from zoho crm

          Hello everyone, I'm planning to write a script in Python or Java in Zoho CRM functions, to access a CBPX file. Is it possible to write this script in the dev console of Zoho? What are the best practices to do this ? Would you have references in the Zoho
        • Calculate hours

          Is there any chance that the the "formula" will have the ability to do calculation using the "time" field in the future? Our company has a form set up for tracking hours worked and we use 2 time fields currently. One for the clock-in time, and one for the clock-out time. It's great for keeping that record, but if there were a way to calculate the hours to show on the report would be awesome. Previously we had used JotForm and their calculator had that ability, but it seems that Zoho doesn't accept
        • Introducing parent-child ticketing in Zoho Desk [Early access]

          Hello Zoho Desk users! We have introduced the parent-child ticketing system to help customer service teams ensure efficient resolution of issues involving multiple, related tickets. You can now combine repetitive and interconnected tickets into parent-child
        • Zoho Books | Product Updates | November 2026

          Hello users, As the year winds down, we've introduced several enhancements to make compliance, inventory management, and everyday bookkeeping easier in Zoho Books. This month's updates include an improved TDS experience, a new way to exchange transactions
        • Zoho Writer workflows now support custom stages, parallel reviews, and external approvers

          Hello everyone, Zoho Writer now lets you build your own approval chains. The pre-built workflows also get new review modes, completion criteria, and external approver support. What’s new Custom workflows: Design review and approval processes from scratch,
        • Expanding sales, marketing, and support capabilities in Zoho CRM Plus 3.0

          Hey everyone, It's been more than 10 years since we launched Zoho CRM Plus back in 2014. This is quite a milestone, and we've come a long way in empowering you with everything you need to offer an exceptional customer experience. On that note, we expanded
        • Erase function in Zoho PDF editor does not truly redact

          Using the "erase" function in the Zoho PDF editor online does not redact the text underneath when opening the file in Adobe. When I used the erase function to whiteout the areas I didn't want to be seen, I opened the supposed redacted files in Adobe.
        • Error creating an XML file

          I am creating an xml as string in the function Employee.generatePartA_XML_String, and then I want to save it as a file to the field "Part_A_XML", but I get the response: {"code":3700,"message":"Unable to upload a file. Please check and try again."} How
        • Thunderbird cannot authenticate Zoho on android

          I keep getting a message from Thunderbird on Android that it could not authenticate for my account, dadashton@zoho.com., and to update my server settings. Now the settings are exactly the same for my other devices (1 Windows, 1 Mac and 2 Linux) Can anybody
        • Mailchimp Integration

          Hello, I am needing some help. Does anybody have a recommended source for information on the Zoho-Mailchimp integration. We are working on a system to import large amounts of records into Zoho that will sync into Mailchimp for us to run a mail campaign out of. Let me explain what the process we are trying to implement - any information or advice is appreciated. Import record data base into Zoho Leads module --> use Lead source to ID records that are part of this mail campaign Zoho Leads (specific
        • [Free webinar] Zoho Creator meets AI with MCP | Creator Tech Connect (November 2026)

          Hello everyone, We are 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 consisting of purely technical sessions, where we dive deep into
        • Invalid Client - Client ID passed does not exist

          I tried connecting the Zoho campaign with the "Uncanny Automator". It shows an error " Invalid Client - Client ID passed does not exist". There is no option to add manual API. URL: https://accounts.zoho.eu/oauth/v2/auth?response_type=code&client_id=1000.MSFIUOA1G8YBK7IFRL9Z0NINM6DW9C&scope=ZohoCampaigns.contact.ALL&redirect_uri=https%3A%2F%2Fapi.automatorplugin.com%2Fv2%2Fzoho-campaigns&prompt=consent&access_type=offline
        • Field of Lookup - 5 Field Association Limit.

          This query relates to the post at: https://help.zoho.com/portal/en/community/topic/introducing-the-field-of-lookup-in-crm-public-early-access-2023 My simple (and common) scenario: I select an account / customer lookup and want their address pulled into
        • Task status - completed - other options

          I have a dumb question I know i can make custom statuses for the tasks - but is there anyway to make additional "completed" statuses like for instance if i have a task "call back customer" and i leave a vm for them to call back marking it "completed -
        • #20 I've Sent It and It's Wrong

          Meera spots a mistake in an invoice just four minutes after sending it. She has billed a photoshoot at the half-day rate instead of the full-day rate. Her first thought is to delete the invoice and start again. But is deleting the right thing to do? It
        • Add Specific Identification as an Inventory Costing Method

          --- Business Context We are a security systems distributor handling high-value, serialized products such as IP cameras, NVRs, and RAID storage systems. Each unit is uniquely identified by a serial number and arrives in separate shipments at varying purchase
        • Zoho Forms API

          Is there any way to get all form entry list using API? Looking forward to hear from you
        • BNZ Bank Feeds No Longer Available

          The BNZ (New Zealand) bank feeds are still failing and it's been months since they last worked! Uploading bank statements (CSV's) mean waiting to the end of the month when they become available. It is unacceptable to keep my clients waiting for payment
        • MCP is now easier to access and configure in Bigin

          Greetings! We hope you're all doing well. We've previously introduced Zoho MCP for Bigin, which lets you connect Bigin with AI tools and interact with your Bigin data using natural language. Now we're making MCP easier to access and configure directly
        • Launch agents from more custom button locations and attach files in Ask Zia

          Hello all, Your agents now meet your team where the work happens. You can add agents to custom buttons in list views, create and edit pages, and related lists, so users launch them without leaving the page they’re on. What’s new Agents in more custom
        • Phone system to integrate with Zoho CRM

          I am looking for phone software that would allow my agency to do the following within Zoho CRM: Make calls from zoho Track calls and notes Leave pre-recorded messages after reaching voicemail of lead Only 2 members, so need company who will allow just
        • Zoho Projects connector with Zoho CRM (Related List module) features

          Hi community, I use Zoho Projects connected to Zoho CRM, where we associate Projects with Deals, clients, etc.. I am looking to change/edit the fields that are available in the integration. Currently it shows Project Status, Project Completion, Milestones,
        • Feature Request: Render Markdown (.md) files in Zoho Cliq

          Hi, We regularly share Markdown (.md) files in Zoho Cliq. However, when we open these files in Cliq, the content does not render as Markdown—it displays as plain text. This forces us to copy/paste the content into an external Markdown viewer to read it
        • Free webinar: Zoho Sign for Microsoft apps

          Hello, Did you know Zoho Sign works right inside the Microsoft apps you already use? A signature request shouldn't mean leaving Teams for another tab, or downloading an Outlook attachment just to sign it. Zoho Sign integrates with Microsoft 365, Teams,
        • Users can now notify the contact while adding a 'Resolution' to the ticket.

          Hello, In the latest version of the Desk iOS mobile app (v2.6.4), users can now notify the contact while adding a 'Resolution' to the ticket. Also, the 'Resolution' UI has been tweaked to support edit and delete option.   Please update the app either
        • Better Time Tracking

          We need better time tracking customization for IT MSPs. We also need reporting that is built in, rather than having to try and fumble with creating custom reports. We also need to be able to mark whether a ticket has been billed or not, I don't think
        • Introducing Custom Fonts for Career Sites

          Your Careers page is often the first place candidates interact with your organization. From exploring job opportunities to submitting applications, a consistent visual experience helps candidates recognize and connect with your brand. To give you more
        • Need help with importing expenses

          I'm using the template downloaded from the application. When I try to import my expenses, I get the message: Duplicate entry in the Expense Date column. Ensure it contains unique values. None of the rows will import. There are duplicate dates, but they
        • time tracking on zoho crm cases

          Is there a time tracking feature in zoho crm cases? I need calculate time spent in calls, tasks and events Thanks in Advance  
        • Integrate with Power BI

          Hi, How to connect Zoho CRM dashboards & reports with POWER BI ?
        • Emails bouncing to Hotmail / Outlook.com

          Today I have seen multiple emails bouncing all to Hotmail and outlook.com mailboxes, all other emails are being delivered. Is it just me or is this a widespread issue with Zoho Books ? Bounce Reason : uncategorized-bounce
        • Zoho Recruit: Time to Step Up Your AI Game!

          I've been using Zoho Recruit for many years and I love it. But let's be honest, it's starting to feel a bit like a relic from the pre-ai era. I recently tried out new systems that have ai resume screening and ai interviewing capabilities, these systems
        • Zoho mail app throwing network error

          Zoho mail app is throwing network error and I do not know how to fix the issue.
        • Cannot unblock account

          Hi, I have recently been travelling for work and now my mail account has been locked due to suspicious activity (I guess login attempts from different countries) however when I go into my admin panel it won’t let me unblock and asks me to contact support.
        • Time logging issues

          I am losing times tracked on tasks. The problem is that it is not clear when the time is logged, when the timer is stopped or when the task is closed? I've done both and neither works. Whats more when the task is closed, the tracked time disapperas (i guess bc it shouldve been logged) but when it's not logged you've just lost your tracked time.  The bigger problem is the UN-NATURAL way this time logging is set up. On every other plat form that tracks time, it is made clear to save timer or log when
        • Start/Stop Timmer in Chrome Extension

          The chrome extension is great and allows you to do allot however one of the most common things employees working on projects need to do is track their time. Having an easy start/stop timer to track time would be great.
        • Employee Logged Hours Report

          Hi Team, We are looking at having all Employees logged hours report, but different staff uses diferent modules to log their time. Is there anywhere that we can get a report that captures every time entered through all Zoho modules? Thank you.
        • Time Log Report Across Zoho Apps?

          Currently there are at least 4 different apps in Zoho where users can book time. Projects Desk Books People In our case for instance, the same user may book time against both Projects and Desk Tickets. So we have no way to see a simple timesheet for a
        • Next Page