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 >>


      Zoho Campaigns Resources


        • Desk Community Learning Series


        • Digest


        • Functions


        • Meetups


        • Kbase


        • Resources


        • Glossary


        • Desk Marketplace


        • MVP Corner


        • Word of the Day


        • Ask the Experts


          Zoho CRM Plus Resources

            Zoho Books Resources


              Zoho Subscriptions Resources

                Zoho Projects Resources


                  Zoho Sprints Resources


                    Zoho Orchestly Resources


                      Zoho Creator Resources


                        Zoho WorkDrive Resources



                          Zoho CRM Resources

                          • CRM Community Learning Series

                            CRM Community Learning Series


                          • Tips

                            Tips

                          • Functions

                            Functions

                          • Meetups

                            Meetups

                          • Kbase

                            Kbase

                          • Resources

                            Resources

                          • Digest

                            Digest

                          • CRM Marketplace

                            CRM Marketplace

                          • MVP Corner

                            MVP Corner




                            Zoho Writer Writer

                            Get Started. Write Away!

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

                              Zoho CRM コンテンツ



                                ご検討中の方

                                  • Recent Topics

                                  • Writer update results in BitDefender blocking it as malware

                                    After updating Writer to latest update, Bitdefender blocked the app and writer no longer runs.
                                  • Is there a way to invoke deluge function from within a widget?

                                    Hi! I have custom functions in deluge and I was wondering whether there is any way to call this function through a widget? Something like on click of a button inside a widget, run the deluge custom function. Would this be possible?
                                  • Missing Import Options

                                    Hello, do I miss something or is there no space import option inside of this application? In ClickUp, you can import from every common application. We don't want to go through every page and export them one by one. That wastes time. We want to centralize
                                  • Zoho CRM Portal Field Level Permission Issue

                                    Hi Support Team, I am using the Zoho CRM Portal and configuring field-level editing permissions. However, we are unable to restrict portal users from editing certain fields. We have created a portal and provided View and Edit (Shared Only) access for
                                  • Why am I seeing deleted records in Zoho Analytics syncing with Zoho CRM?

                                    I have done a data sync between Zoho CRM and Zoho Analytics, and the recycle bin is empty. Why do I see deleted leads/deals/contacts in Zoho Analytics if it doesn't exist in Zoho CRM? How can I solve this problem? Thanks
                                  • Zoho Tables is now live in Australia & New Zealand!

                                    Hey everyone! We’ve got some great news to share — Zoho Tables is now officially available in the Australian Data Center serving users across Australia and New Zealand regions! Yes, it took us a bit longer to get here, but this version of Zoho Tables
                                  • Custom Fonts in Zoho CRM Template Builder

                                    Hi, I am currently creating a new template for our quotes using the Zoho CRM template builder. However, I noticed that there is no option to add custom fonts to the template builder. It would greatly enhance the flexibility and branding capabilities if
                                  • Introducing the Zoho Projects Learning Space

                                    Every product has its learning curve, and sometimes having a guided path makes the learning experience smoother. With that goal, we introduce a dedicated learning space for Zoho Projects, a platform where you can explore lessons, learn at your own pace,
                                  • All new Address Field in Zoho CRM: maintain structured and accurate address inputs

                                    The address field will be available exclusively for IN DC users. We'll keep you updated on the DC-specific rollout soon. It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition. Latest update
                                  • Import Function: ONLY update empty fields

                                    When setting up an import from a spreadsheet to CRM, there is a checkbox "Don't update empty values for existing contacts" (see screenshot below). While I see some limited benefit from this functionality, I think there should also be an "ONLY update empty
                                  • Collaboration with customers made easy with Zoom Meeting and Zoho Desk integration

                                    Hello everyone! We are happy to announce that you can now integrate your Zoho Desk account with Zoom Meeting. The integration bridges the gap between digital communication and human connection, empowering teams to deliver timely support when it matters
                                  • CRM Canvas - Upload Attachments

                                    I am in the process of changing my screens to Canvas.  On one screen, I have tabs with related lists, one of which is attachments.  There doesn't appear to be a way to upload documents though.  Am I missing something really obvious?  Does anyone have
                                  • TrueSync regularly filling up my local disk

                                    Seems that WorkDrive's TrueSync randomly starts filling up my local hard drive space. None of the folders have been set as "Make Offline" but still it seems to randomly start making file offline. The settings of the app is so minimal and is of no real
                                  • Kaizen #194 : Trigger Client Script via Custom buttons

                                    Hello everyone! Welcome back to another interesting and useful Kaizen post. We know that Client Scripts can be triggered with Canvas buttons and we discussed this with a use case in Kaizen#180. Today, let us discuss how to trigger Client Script when a
                                  • [Webinar] A recap of Zoho Writer in 2025

                                    Hi Zoho Writer users, We're excited to announce Zoho Writer's webinar for January 2026: A recap of Zoho Writer in 2025. This webinar will provide a recap of the features and enhancements we added in 2025 to enhance your productivity. Choose your preferred
                                  • Picklist field shows "none" as default

                                    Hello, Is there an option to avoid showing "none" as the default value in a picklist field? I also don't want to see any option displayed. My expectation is to have a blank bar, and then when I display the drop-down list, I can choose whichever I wa
                                  • Stage-probability mapping feature in custom module

                                    Hi, I'm building a custom module for manage projects. I would like to implement the stage-probability feature that Potentials has. Is this possible?
                                  • Create static subforms in Zoho CRM: streamline data entry with pre-defined values

                                    Last modified on (9 July, 2025): This feature was available in early access and is currently being rolled out to customers in phases. Currently available for users in the the AU, CA, and SA DCs. It will be enabled for the remaining DCs in the next couple
                                  • Field Description is very small

                                    Hello, The field Description in the activity is very small. Why don't try open a new window, or a bigger popup, or increase the width of the "popup". Example:
                                  • StatusIQ

                                    Please add StatusIQ to data sources. We using site24x7 and StatusIQ together and site24x7 integration is already there. Thanks and regards, Torsten
                                  • In Zoho People, the Operations buttons are frequently not visible or do not appear consistently.

                                    In Zoho People, the Operations buttons are frequently not visible or do not appear consistently. We request you to please investigate and address this issue, as it is affecting daily HR operations and user access.
                                  • Marketing Tip #14: Increase cart value with product bundles

                                    Bundling products is a great way to increase average order value while giving customers more convenience. Think “camera + tripod + memory card” or “soap + lotion + bath salts.” Bundles make shopping easier and feel like a better deal. It’s a win-win for
                                  • Problem with Workdrive folders

                                    I'm having a problem a problem accessing files in a Zoho work drive folder when using the Zoho writer app. The problem folder appears grayed out in the Zoho work drive window in both the online and writer application. However I can open the folder in
                                  • Sortie de Zoho TABLE ??

                                    Bonjour, Depuis bientôt 2 ans l'application zoho table est sortie en dehors de l'UE ? Depuis un an elle est annoncée en Europe Mais en vrai, c'est pour quand exactement ??
                                  • Add RTL and Hebrew Support for Candidate Portal (and Other Zoho Recruit Portals)

                                    Dear Zoho Recruit Team, I hope you're doing well. We would like to request the ability to set the Candidate Portal to be Right-to-Left (RTL) and in Hebrew, similar to the existing functionality for the Career Site. Currently, when we set the Career Site
                                  • Auto tracking URL generation based on Carrier

                                    Hi, While creating a shipment order for a package in Zoho Books, I have a requirement that for example, if the carrier is Delhivery and tracking number is 1234, then can automatically the tracking link/URL be generated as www.delhivery.com/1234. Similary,
                                  • Zoho Bookings form pre-filled with Zoho Forms in

                                    Hi, I've got a contact page on my website and I'd like to have the option to book an appointment (redirected to zoho bookings page) after an option is submitted on the contact form. how would I go about doing this? thanks
                                  • Pre-orders at Zoho Commerce

                                    We plan to have regular producs that are avaliable for purchase now and we plan to have products that will be avaliable in 2-4 weeks. How we can take the pre-orders for these products? We need to take the money for the product now, but the delivery will
                                  • Customer ticket creation via Microsoft Teams

                                    Hi all, I'm looking to see if someone could point me in the right direction. I'd love to make it so my customers/ end users can make tickets, see responses and respond within microsoft teams. As Admin and an Agent i've installed the zoho assist app within
                                  • Zoho Books' 2025 Wrapped

                                    Before we turn the page to a new year, it’s time to revisit the updates that made financial management simpler and more intuitive. This annual roundup brings together the most impactful features and enhancements we delivered in 2025, offering a clear
                                  • Can multiple agents be assigned to one ticket on purpose?

                                    Is it possible to assign one ticket to two or more agents at a time? I would like the option to have multiple people working on one ticket so that the same ticket is viewable for those agents on their list of pending tickets. Is something like this currently
                                  • This user is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details

                                    Hi Team, when I,m trying to create a email account (imagixmidia.com.br) it's showing this error >>  This user is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details plz help me  thanks
                                  • Edit default "We are here to help you" text in chat SalesIQ widget

                                    Does anyone know how this text can be edited? I can't find it anywhere in settings. Thanks!
                                  • Can't change form's original name in URL

                                    Hi all, I have been duplicating + editing forms for jobs regarding the same department to maintain formatting + styling. The issue I've not run into is because I've duplicated it from an existing form, the URL doesn't seem to want to update with the new
                                  • Feature Request: Sync Leave Tracker to Zoho Mail / Calendar or provide option to download information

                                    Zoho Leave Tracker offers the option to sync the leave Calendar to Microsoft 365 and Google Calendar. Adding an option to sync to Zoho-Mail Calendar would avoid duplication and add significant value for users. An alternative would be to allow users to
                                  • Compensation | Salary Packages - Hourly Wage Needed

                                    The US Bureau of Labor Statistics says 55.7% of all workers in the US are paid by the hour. I don't know how that compares to the rest of the world, but I would think that this alone would justify the need for having an hourly-based salary package option.
                                  • Multiple currencies - doesn’t seem to work for site visitors / customers

                                    I am trying to understand how the multiple currency feature works from the perspective of the website visitor who is shopping on my Zoho Commerce site. My site’s base currency is US Dollars (USD) but my store is for customers in Costa Rica and I would
                                  • Archiving Contacts

                                    How do I archive a list of contacts, or individual contacts?
                                  • How do people handle using Outlook and Zoho Project calendar at the same time?

                                    We have an ongoing problem in our organisation where we use Zoho Projects to plan all of our projects tasks and that also allows us to look forward using the workload report to see which of our consultants are overstretched etc and which are available.
                                  • 10GB Email Storage Limits in Zoho CRM

                                    We’ve had Zoho One for almost 5 years and have always synced our emails from Gmail via IMAP… As of late, we’ve run into issues with our emails not syncing, due to being over the 10GB storage cap… What’s very odd is that we haven’t changed a thing? I know
                                  • Next Page