Building Extensions #9: Create widgets with the JS SDK bundle in Zoho Desk - Request API

Building Extensions #9: Create widgets with the JS SDK bundle in Zoho Desk - Request API

This series aims to equip developers with all they need to build extensions for Zoho Desk in Zoho Sigma and publish them in Zoho Marketplace.

In our previous post, we introduced you to creating widgets in Zoho Desk with different APIs. We also gave a rundown on other data API sets and their functions. In this post, we'll continue this brief by showing you how to use Request APIs in the Zoho platform (Sigma) to build extensions for Zoho Desk.

Request API

While building an extension, you may be required to communicate with third-party applications through APIs. Let's say you want to request information from a third-party app and view it within your own. A request API allows you to reach the third-party app's API and obtain the information you need. It also avoids CORS-related issues and successfully runs the third-party API in your extension, meaning that you have consistent access to the information without having to run the request over and over.

Calling third-party APIs

A request API requires an object as its parameter. The request object must contain the values for the following keys.
  • url: Refers to the third-party API
  • headers: HTTP header
  • type: HTTP method type
  • data: Pass a query parameter as an object
  • postBody: Parameters to be set to API
  • connectionLinkName: Name of the connector that is configured in Sigma to contact a third party
Here is a sample code snippet of the request API's request object:
      var reqObj=
      {
            url : 'http://demo2022863.mockable.io/test',
            headers : { 'Content-Type' : 'application/json' },
            type : 'GET',
            data : { 'test' : "key" },
            postBody : {},
            connectionLinkName : "connectionLinkName specified in the connectors section in plugin-manifest file"
      }
      ZOHODESK.request( reqObj ).then(function(response){
            // Response for the url
      }).catch(function(err){
            // Error handling
      })

Scenario: Let's consider you are building an extension that needs to fetch customer data from the Contacts module in Zoho CRM and add it to the Customers module in Zoho Desk. To execute this function, you must establish a connection between Zoho Desk and Zoho CRM with the required parameters. This will allow you to make requests to these services by invoking their APIs. Check out "Building Extensions #6" to learn more about these connections.




Once the connection is established, a JSON file will be created. It then has to be added to the 'zohoAuthorisation' key of the plugin-manifest.json file.

Note: When you create a connection using Zoho OAuth, you need to add "type":"connectors" along with the other keys. Refer to the code snippet given below.

Also, under whiteListedDomains, the API domains of Zoho CRM and Zoho Desk must be added to ensure a secure data transfer between the two applications.


Note: Data transfer between Zoho Desk and any other third-party providers can also be facilitated in the same way.

Once the connection is established and the configurations are completed in the plugin-manifest.json file, you can go ahead and call the required APIs to implement the feature.

As mentioned earlier, we need to fetch a record from the Contacts module of Zoho CRM and push that data to the Customers module of Zoho Desk. So let's see how these APIs are invoked using the ZOHODESK.request JS SDK method.

The code below demonstrates how a particular record can be fetched from Zoho CRM and pushed in to Zoho Desk.
  • Use ZOHODESK.request and invoke Zoho CRM's "get record" API. In our code, we have fetched a record by its ID.
  • Construct the request object for ZOHODESK.request.
    {
          url : 'https://www.zohoapis.com/crm/v2/Contacts/39XXXXXXXXXXXXXXXX89',
          headers : {'Content-type' : 'application/json'},
          type : 'GET',
          data : {},
          connectionLinkName : 'zohocrm',
          postBody : {},contentType: "application/json",dataType: "json",service : ""
    }
  • Extract the required values from the response of the request.
  • Use ZOHODESK.request to invoke Zoho Desk's "Create Contacts" API.
  • Now use the data extracted from Zoho CRM to construct the request object for pushing the data into Zoho Desk.
    {
          url : 'https://desk.zoho.com/api/v1/contacts',
          headers : {'Content-Type' : 'application/json', 'orgId':'69XXXXX84'},
          type : 'POST',
          data : {},
          connectionLinkName : 'zohocrm',
          postBody : {"lastName" : name,
          "email" : email},
          contentType: "application/json",
          dataType: "json",
          service : ""
    }


In this code, the email and last name of a particular contact from the Contacts module in Zoho CRM is chosen to be pushed into the Customers module in Zoho Desk.

We hope that the example code above has given you a clear picture on how to use the JS SDK method ZOHODESK.request. Stay tuned for our next post where we will discuss another SDK method.

See Also


<<Previous                                                                                                                                         Next >>

    Access your files securely from anywhere


            Zoho FSM Video Tutorials


                  All-in-one knowledge management and training platform for your employees and customers.






                                        Zoho Developer Community




                                                              • Desk Community Learning Series


                                                              • Digest


                                                              • Functions


                                                              • Meetups


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner


                                                              • Word of the Day


                                                              • Ask the Experts





                                                                        Manage your brands on social media



                                                                              Zoho TeamInbox Resources



                                                                                  Zoho CRM Plus Resources

                                                                                    Zoho Books Resources


                                                                                      Zoho Billing Resources

                                                                                        Zoho Projects Resources


                                                                                          Zoho Sprints Resources


                                                                                            Qntrl Resources


                                                                                              Zoho Creator Resources



                                                                                                  Zoho CRM Resources

                                                                                                  • CRM Community Learning Series

                                                                                                    CRM Community Learning Series


                                                                                                  • Kaizen

                                                                                                    Kaizen

                                                                                                  • Functions

                                                                                                    Functions

                                                                                                  • Meetups

                                                                                                    Meetups

                                                                                                  • Kbase

                                                                                                    Kbase

                                                                                                  • Resources

                                                                                                    Resources

                                                                                                  • Digest

                                                                                                    Digest

                                                                                                  • CRM Marketplace

                                                                                                    CRM Marketplace

                                                                                                  • MVP Corner

                                                                                                    MVP Corner






                                                                                                      Design. Discuss. Deliver.

                                                                                                      Create visually engaging stories with Zoho Show.

                                                                                                      Get Started Now


                                                                                                        Zoho Show Resources

                                                                                                          Zoho Writer

                                                                                                          Get Started. Write Away!

                                                                                                          Writer is a powerful online word processor, designed for collaborative work.

                                                                                                            Zoho CRM コンテンツ


                                                                                                              Nederlandse Hulpbronnen


                                                                                                                  ご検討中の方




                                                                                                                            • Recent Topics

                                                                                                                            • Duplicate Record Creation

                                                                                                                              Hello Team, I would like to check whether there are any options available in Zoho FSM to prevent duplicate record creation in the following modules: Assets Companies Contacts Ideally, we would like the system to check for existing records before allowing
                                                                                                                            • Change default "Sort by"

                                                                                                                              Is there a way to change the default "sort by" when searching across modules?" in Zoho CRM? Currently the default sort method is "Modified time" but i would like to utilize the second option of "relevance" as the sort by default and not have to change
                                                                                                                            • Enhanced access controls and smoother authentication for organization emails

                                                                                                                              Available to customers in all DCs. Hello everyone, We've improved how organization emails work in Zoho CRM, which are used when multiple users need to send emails from a common address, like sales@company.com or support@company.com. Admins can set up
                                                                                                                            • New Search Function

                                                                                                                              Hey Team, The search function updated in our CRM about a week ago, so I assume it was an automated update across Zoho. It no longer displays leads/deals etc in Chronological order so that the most recently created or updated is the first to display which
                                                                                                                            • Error AS101 when adding new email alias

                                                                                                                              Hi, I am trying to add apple@(mydomain).com The error AS101 is shown while I try to add the alias.
                                                                                                                            • VENDORS ARE NOT SYNCHED WITH CONTACTS IN CRM

                                                                                                                              Hello, While the ACCOUNTS and CONTACTS (Including the primary contact) are synced with the CONTACTS module in CRM, the vendor's CONTACTS are not synced with CRM - which basically forces the users to re-enter all vendor's contacts twice and then update
                                                                                                                            • Transaction rules for "Owner's Contribution" ?

                                                                                                                              I have a bank account where a lot of the deposits are "Owner's Contributions" (i.e., the business owner investing money in the company). Is it possible to create a Transaction Rule to automatically recognize these? They all have the same verbiage from
                                                                                                                            • Print a price list or price book

                                                                                                                              Hi Community. Am I right in concluding that Zoho has no functionality to print a price list from either Zoho CRM, Zoho Inventory or Zoho Books? I won't get stuck on the fact that Zoho doesn't sync price books between Zoho CRM and Books/Inventory (more
                                                                                                                            • The Social Wall: October 2026

                                                                                                                              Hello everyone This month, we're making it easier to organize your monitoring workspace with Monitor Groups in Zoho Social. Organize your monitor columns into groups You can now organize your monitor columns into custom groups based on your preferences.
                                                                                                                            • 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
                                                                                                                            • Feature Request - Electronic submission of tax returns in Canada

                                                                                                                              Allow the user to submit Canada Revenue Agency GST/HST returns with NETFILE. Provide the same functionality for provincial revenue agencies for PST/RST remittances. Today Zoho Books only provides the math required to calculate each line, requiring the
                                                                                                                            • Ability to translate Zoho CRM Kiosks

                                                                                                                              Hi team, Is support for translating kiosk text and screen names in the Zoho CRM translation tool planned on the roadmap? Thanks,
                                                                                                                            • 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
                                                                                                                            • Request for Zoho Desk Version and Module Details

                                                                                                                              Kindly help us confirm the version of Zoho Desk currently being used in our portal, along with the module/edition name. We require this information urgently for our internal documentation.
                                                                                                                            • ZohoMail_get_mail_attachment corrupts binary attachments (PDFs) over MCP

                                                                                                                              Hi all, The Zoho Mail MCP tool ZohoMail_get_mail_attachment returns binary attachments as UTF-8 text, so PDFs come back corrupted and an AI client can't read or save them. What we see: - The response header is content-type: application/octet-stream;charset=UTF-8.
                                                                                                                            • Request: Custom CSS Theme

                                                                                                                              I would really like a custom CSS theme that enables me to completely customize the look and feel of the survey page based on the typography of my company brand. Unfortunately, there does not appear to be complete customization with existing themes. This
                                                                                                                            • KB Articles - Can't See Content or Trigger Immediate Sync

                                                                                                                              Once a file has been submitted to the KB, there's no way to check what it actually contains. There's also no way to force an immediate sync with the source document. These are issues when one is developing and testing an agent. It makes troubleshooting
                                                                                                                            • Rebrand your CRM with the all-new custom domain mapping setup

                                                                                                                              UPDATES TO THIS FEATURE! 19th Jan, 2024 — Custom domain mapping has been made available for portal users in Zoho One and CRM Plus. 23rd June, 2023 — Custom domain mapping has been made available for all users, in all DCs. Hello everyone! We are elated
                                                                                                                            • Découvrez le nouveau Zoho Analytics : l’analytique agentique pour toutes les entreprises

                                                                                                                              Nous sommes ravis de vous annoncer le lancement du tout nouveau Zoho Analytics ! Cette nouvelle version marque un tournant majeur dans l’évolution de la plateforme. Initialement conçue comme une solution de BI en libre-service permettant de créer des
                                                                                                                            • Zia Agents in Zoho CRM: a better way to set up digital employees

                                                                                                                              Hello everyone, If you've been using Zia Agents in Zoho CRM, so far using Connections was the only deployment method you're familiar with. You create an agent in Zia Agents (define its objective, write instructions, use tools, add knowledge base) and
                                                                                                                            • Keeping phone number text format exporting from Books to Sheet

                                                                                                                              We have a custom function that copies data from our customers in Books to Sheets. In the process the customers' phone numbers (unless they contain a space) get treated as numeric values, so leading zeros get stripped off, and in some cases scientific
                                                                                                                            • Admin Logging in as another User

                                                                                                                              How can a Super Admin login as another user. For example, I have a sales rep that is having issues with their Accounts and I want to view their Zoho Account with out having to do a GTM and sharing screens. Latest Update (27th April 2026): With the early
                                                                                                                            • Tool Parameter UI - Freeze Header

                                                                                                                              When one has a number of tools with a number of parameters, scrolling down hides the heading information, forcing one to scroll back up to get confirmation which radio button is which: Seems like simply freezing the header would eliminate that issue.
                                                                                                                            • Cannot replace custom tools

                                                                                                                              This is so incredibly frustrating. Create a tool group. Add your custom schema to create your custom tools. Attach to an Agent. Now you need to update your schema to make an adjustment? You can't edit the schema or even re-upload a new schema. It blocks
                                                                                                                            • Testing Tools - Can't View Response

                                                                                                                              When adding a custom tool and trying to test it, one can see whether or not the test has a successful http response, but the actual payload cannot be viewed to verify the tool's performance. I thought that's what the little hover link was for, but mousing
                                                                                                                            • more native app support for linux

                                                                                                                              Dear zoho,pls build additional apps like zoho valt,zoho sheets,zoho show,zoho authenticator apps for linux ,because more and more people are increasing switching to linux this days,
                                                                                                                            • Unbundle feature for composite items

                                                                                                                              We receive composite items from our vendors and sell them either individually or create other composite items out of them. So, there is a lot of bundling and unbundling involved with our composite items. Previously, this feature was supported in form
                                                                                                                            • Quick Reference Guide on join.zoho.com

                                                                                                                              Joining a remote session can be difficult for the people who need it the most. Please add a quick reference guide and better documentation that my Grandma can read on the join.zoho.com site. It's not uncommon to spend 10minutes or longer in a session
                                                                                                                            • Zoho Projects - Auto Populate Project on Project Invoices

                                                                                                                              Hi Projects team, I noticed that when creating an invoice from a Project in Zoho Projects, the project is not selected on the invoice. Is this something which you would consider as a feature request? It seems silly that when you create an invoice from
                                                                                                                            • Times prepopulating in Date/Time field on deal records

                                                                                                                              Support tells me that there is no workaround to having the time auto-fill on a date/time field in our deal records -- that is HUGELY inconvenient and creates massive opportunity for error. Our deals involve several parts over various days/times, none
                                                                                                                            • Email-Data Synchronization with Zoho Analytics

                                                                                                                              Hello, Enterprise Support Community! We're excited to announce the availability of Email Data Synchronization with Zoho Analytics! This highly requested enhancement allows you to sync email data from Zoho CRM into Zoho Analytics, making it easier to analyze
                                                                                                                            • Multi-Day Installations

                                                                                                                              We schedule technicians on multi-day installations. A single appointment from Monday 8 AM through Friday 5 PM counts as 105 working hours, causing false overbooking. We need one appointment spanning five days but only 40 hours counted toward technician
                                                                                                                            • Making shared forms available offline

                                                                                                                              Hi, We used to be able to have our forms available offline even if it was a shared form. now we can't. Is this a new bug?
                                                                                                                            • Zoho Forms API

                                                                                                                              Is there any way to get all form entry list using API? Looking forward to hear from you
                                                                                                                            • Documents greater than 40MB Preview

                                                                                                                              hello, Documents bigger than 40 MB cannot be previewed in WorkDrive Web App or Mobile App. would it be resolved in future?
                                                                                                                            • Calendar Booking - Related Deal

                                                                                                                              Is it possible to automatically associate a Calendar Booking with an existing Deal in Zoho CRM? We're trying to use the native Calendar Booking feature. Our goal is to send a booking link to a customer from an existing Deal record, so that when the customer
                                                                                                                            • Approval Process configuration is now more flexible and fully customizable

                                                                                                                              Hello everyone! Approval Process is back with a better user experience that makes it easier to add rules to your processes. This enhancement includes some UI updates that help you create highly structured approval stages—and more. Let's look at the enhancements
                                                                                                                            • Kaizen #268: Using Zoho MCP to Build and Configure Zoho CRM Cadences

                                                                                                                              Hi everyone! Welcome back to the Kaizen series! In the previous Kaizen posts, Kaizen #265 and Kaizen #266, we explored how Zoho MCP can be used to work with Zoho CRM records, retrieve metadata, customize CRM, configure automation, and even coordinate
                                                                                                                            • Deliverability Update: Impact of the Ongoing Microsoft 365 Service Disruption on Email Delivery

                                                                                                                              Update (November 16, 2026): This incident is resolved. In its final update on November 14, Microsoft confirmed that all affected services have fully recovered and the backlog of email messages has been processed. Microsoft lists the end of impact as November
                                                                                                                            • Trigger a Workflow Function if an Attachment (Related List) has been added

                                                                                                                              Hello, I have a Case Module with a related list which is Attachment. I want to trigger a workflow if I added an attachment. I've seen some topics about this in zoho community that was posted few months ago and based on the answers, there is no trigger
                                                                                                                            • Next Page