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

                                                                                                              • Getting Project Template List using the REST API

                                                                                                                I am trying to confirm that I can use the REST API to create a project using a project template. The API documentation indicates this is possible by providing the Template ID, but it is not clear at all how to get a list of available Project Templates
                                                                                                              • How to get Quickbooks Desktop Info into Zoho?

                                                                                                                Our team has used Quickbooks desktop for years and is looking at switching to Zoho books in 2026. I want to bring all old sales history over since we use Zoho CRM. I can export Item sales history and generic sales orders from Quickbooks desktop. How do
                                                                                                              • ZeptoMail API Request

                                                                                                                We tried to send mail using ZeptoMail using Django. Following is my payload {'from': {'address': 'abc@abc.com'}, 'to': [{'email_address': {'address': 'xyz@xyz.in', 'name': 'Bhavik'}}], 'subject': 'Report Name', 'htmlbody': '<p>Test</p>'} Following is
                                                                                                              • Zoho Inventory - Allow Update of Marketplace Generated Sales Orders via API

                                                                                                                Hi Inventory Team, I was recently asked by a client to create an automation which updated a Zoho Inventory Sales Order if a Shopify Order was updated. I have created the script but I found that the request is blocked as the Sales Order was generated by
                                                                                                              • Mass import of documents into Zoho Writer

                                                                                                                I'm using Google's word processor at the moment but feel that Zoho does a better job (on the online apps market). Iwant to move my documents (about 50-70) to Zoho but it seems to me that I have to import them seperately. Is it already possible to upload several documents at a time or is this a forthcoming feature? Cheers Rolli :?:
                                                                                                              • Add home page or dashboard in CRM customer portal

                                                                                                                is it possible to add home page or dashboard in CRM customer portal?
                                                                                                              • User Tips: How to change the the label display name of a system defined field

                                                                                                                Most users know how to change field label names via Settings > Modules & Fields but if you want to change the name of a system defined field you can’t as there is no “edit properties” option.  However with a simple hack you can edit any system defined
                                                                                                              • Search not working!

                                                                                                                I have items in my notebook tagged but when I search for a tag nothing comes up! Any fix for this?
                                                                                                              • Zoho CRM Community Digest - October 2025 | Part 1

                                                                                                                Hello Everyone! Here's a quick recap of first two weeks of October! Product Updates: Zoho CRM Android App Update: Surveys, Blueprints, and Smarter Mobile Features! Zoho CRM’s Android app just got a useful upgrade. You can now share records, upload your
                                                                                                              • Automate onboarding emails with CRM Workflow and Accounts module

                                                                                                                We’re a B2B SaaS company selling to public-sector organisations. Each organisation is stored as an Account in Zoho CRM, and each organisation typically has multiple associated Contacts. Our backend syncs product-usage data (setup status, user activity,
                                                                                                              • Important update: Enhanced security measures for account operations in Zoho Cliq

                                                                                                                Greetings from the Zoho Cliq team! We’d like to share an important security update that has an influence on some admin actions such as password reset, MFA reset, and MFA backup code generation. What’s changing? With our latest security enhancements, these
                                                                                                              • Sales Receipts Duplicating when I run reports why and how do we rectify this and any other report if this happens

                                                                                                                find attached extract of my report
                                                                                                              • No Functional Autosave or Manual Save Button

                                                                                                                Application : Zoho Notebook So I wanted to try Zoho Notebook(On Ubuntu) as an application, I installed the application and went solving my LeetCode problems visually(Drawing mode), at one point the app just stopped saving anything... Every time I tried
                                                                                                              • Enterprise subscription support

                                                                                                                My organization sells subscription services to enterprise customers, which is a different model from the consumer subscription model that Zoho Billing has been designed to support and I beleve this capability should be added. An enterprise subscription
                                                                                                              • Issue with Creator's IF logic

                                                                                                                Hi, I found the following code produces unexpected results: if(-1.0 < 0.0000000) {       info "True"; } else {       info "False"; } if(-1.0 < 0.000000) {       info "True"; } else {       info "False"; } The output returned is: False True However, the
                                                                                                              • Need option to send Package PDF in shipment email (Shipment PDF is missing Lot info)

                                                                                                                Is there any way to automatically attach the Package PDF instead of (or alongside) the Shipment PDF in the notification emails? We really need this feature because the default Shipment PDF creates a blind spot for our customers. It does not display Batch/Lot
                                                                                                              • zoho creator view is not present in the workspace and blank reports

                                                                                                                Hi Support,  Users who have "write" permissions keep getting this error for all of our embedded reports all of a sudden. See screen shot below: Meanwhile, my developer permissions account sees a blank screen in view and edit mode as shown in the screenshots
                                                                                                              • Customize portal email template

                                                                                                                Can i fetch only first name of the user in portal email template instead of the below code Hi ${User.FULL_NAME}
                                                                                                              • Can't we let users decide which options they'd like to add at embed widget?

                                                                                                                It seems embed widget DOES NOT offer a feature, where users can choose options upon subscribing plans. What Zoho has instead, is that admins have to manually create plan with options. How come no one in Zoho dev team never raised issue about usability
                                                                                                              • Reupload and rename from one field to another field (file upload)

                                                                                                                Hi Everyone, Sorry, i have question to use invoke url for rename and reupload attachments file to another field. Tested on development mode. Zoho C6. Refer to https://www.zoho.com/creator/help/api/v2/upload-file.html look my error notification. Does anyone
                                                                                                              • Printing Multi-Page Reports (PDF Export)

                                                                                                                Hi, I am moving a report from Google's Looker Studio to Zoho Analytics and trying to reproduce the Looker page by page dashboard editing experience. With Google, what you see is what you get when you print to PDF. But I can't seem to create the same experience
                                                                                                              • I NEED TO NUMBER TO TEXT NO HERE

                                                                                                                =NUMBERTEXT NEEED
                                                                                                              • Error: View is not present in the workspace

                                                                                                                When saving a dashboard, user receives a popup with the following error. "View is not present in the workspace" What does this mean or refer to? There is no further insight given.
                                                                                                              • Dear Zoho CEO: Business Growth is about how you prioritise!

                                                                                                                All of us in business know that when you get your priorities right, your business grows. Zoho CRM and Zoho Books are excellent products, but sadly, Zoho Inventory continues to lag behind. Just this morning, I received yet another one-sided email about
                                                                                                              • Bin Locations

                                                                                                                Dear all, I am wondering if someone has the ability to develop the bin locations option for zoho inventory (integrated with zoho books) Regards, Ryan
                                                                                                              • Create and populate a record in an instant: Introducing zero-shot field prompting to Zia's ICR

                                                                                                                A couple of months ago, we upgraded our in-house AI image detection and validation tool, Zia Vision, with intelligent character recognition (ICR). By training Zia with sample images, you could create and enrich CRM records with data extracted from standard
                                                                                                              • How to Prevent Users From Skipping LMS Videos in Zoho People

                                                                                                                How to Prevent Users From Skipping LMS Videos in Zoho People Hello Zoho Developers, In this blog, we will quickly look at how you can stop users from skipping or fast-forwarding videos in Zoho People LMS. Zoho People provides a feature called Disable
                                                                                                              • [Integration Edition] Deluge Learning Series – Custom API with Deluge | November 2025

                                                                                                                We’re excited to conclude this four-month Integration Edition of the Deluge Learning Series: Session 1 – Integrating Zoho Apps with Deluge Using Built-In Integration Tasks Session 2 – Integrating Zoho Apps with Deluge Using invokeURL and invokeAPI Session
                                                                                                              • Automate Backups

                                                                                                                This is a feature request. Consider adding an auto backup feature. Where when you turn it on, it will auto backup on the 15-day schedule. For additional consideration, allow for the export of module data via API calls. Thank you for your consideration.
                                                                                                              • Tips for Organizing Workflows and Improving Team Coordination in Zoho

                                                                                                                Hi everyone, I’m looking for some general advice on how different teams are organizing their daily work within Zoho’s apps. Our team recently expanded, and we’re trying to streamline how tasks, discussions, and documents are shared so everything stays
                                                                                                              • Prevent user from viewing all records?

                                                                                                                I have a report that is meant to be used by vendors to view only the records that are assigned to them. All the vendor information is stored in a separate application, so I need to call a function to get the current user's ID (not the zoho user ID). The report settings criteria doesn't support using function calls, so instead I'm embedding the report in an html page like this: if (thisapp.Global.CurrentUserIs("Vendor")) {       personID = common.getLoggedInPersonID();       query = "Assigned_Vendor.ID="
                                                                                                              • Zoho Site pages not displaying in iframes

                                                                                                                I simply want to show a Zoho Site page inside an iframe on another non Zoho website. When testing this across many browsers, the iframe content simply does not appear. IE reports that the host does not allow their content to be displayed in iframes. Very disappointing. Is there a way around this please? Here is the URL of the page I would like to appear in an iframe. http://ips-properties-to-rent.zohosites.com
                                                                                                              • Zoho Inventory as connector in Zoho Creator

                                                                                                                Hello, It doesn't appear that Zoho Inventory is one of the many built in connectors in Zoho Creator? I see that there are non-Zoho inventory applications that have built in connectors such as Cin7, which leads me to believe that I'm missing something
                                                                                                              • Customer Parent Account or Sub-Customer Account

                                                                                                                Some of clients as they have 50 to 300 branches, they required separate account statement with outlet name and number; which means we have to open new account for each branch individually. However, the main issue is that, when they make a payment, they
                                                                                                              • Send Zoho Forms Link using Zoho CRM Email Templates

                                                                                                                I have set up Zoho Forms and CRM integration to pre-populate data from Zoho CRM to Zoho Forms. The setup is working fine. I have also created an email template in the Zoho CRM deals module to send Zoho forms links. So when I send an email using that template
                                                                                                              • My go to On Load Client Script - Fast, efficient, and works for ALL profiles; Hides everything except initial fields

                                                                                                                This is my on Load client script that I use for Create pages. I use a modified version for Edit and Display pages which you can create yourself using the same basic structure that I will give you below. First up, the script. Below that will be an explanation
                                                                                                              • Custom Search using HTM+CSS Snippet

                                                                                                                Suppose I wanted to create my own list view using HTML and CSS snippets inside a Page with a custom search input at the top of the list (not the Search snippet). Without Javascript, is there a way to retrieve a user's entry from that search input and
                                                                                                              • Mass Update of Lookup Fields not possible

                                                                                                                Hello List I've created a custom field for Leads and Contacts 'Current Campaign'. This is very Handy as I can filter leads and then related them to a campaign. Everything ready, but then I realized that mass update doesn't work for lookup fields... a
                                                                                                              • Zoho CRM Kiosk Upload Files

                                                                                                                Hello all, We are trying out Kiosks at the moment to see where it can fit best in our business. We are still a bit off in the application but lets say we will sort this out. My question is the following - when I create a Kiosk I can add "File Upload"
                                                                                                              • Double opt-in notifications and customizable confirmation messages for your webforms

                                                                                                                Dear CRM Community, We are excited to announce a major upgrade to our Webforms feature. You can now customize the confirmation message shown to your users who double opt-in from your webform and also customize your confirmation emails when they submit
                                                                                                              • Next Page