Building Extensions #5: Configuration setup while building extensions - Part 1

Building Extensions #5: Configuration setup while building extensions - Part 1

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.
 
With our series of posts so far, we have introduced you to our development environment setup (Sigma) to build extensions and the steps needed to upload them in Zoho Marketplace. This post will brief you on the configuration settings that are necessary while building extensions for Zoho Desk.
 
Extensions can either add a new custom feature to Zoho Desk that suits your business needs or integrate a third-party application with Zoho Desk. You may also use the advanced features provided within Zoho Desk to weave and craft sophisticated apps for Zoho Desk.
 
Regardless of the type of extension you may build, configuration details play an important role in them. The information needed to set up the extension should be added as a part of the configuration while building an extension. The location to load the extension widget within Zoho Desk, the authorized communication between Zoho Desk and third-party applications, and all the other required information are configured in the plugin-manifest.json file that is stored in the extension project directory.

Plugin-manifest 

The plugin-manifest file is included in the extension project directory by default. It has various keys included in it, each serving a unique function for configuring the extension. Let's explore the purpose of the keys that are included in the plugin-manifest file.

{

  "locale": [

    "en"

  ],

  "service": "DESK",

  "storage": false,

  "type": "personal",

  "whiteListedDomains": [],

  "modules": {

    "widgets": [

      {

        "location": "desk.ticket.detail.rightpanel",

        "url": "/app/widget.html",

        "name": "Desk Extension",

        "logo": "/app/img/logo.png",

        "icon": "/app/img/icon.png"

      }

    ]

  },

  "zohoAuthorisation": {},

  "connectors": [],

  "config": [],

  "moduleSupport": false

      }

locale

The details regarding the languages supported by the extension have to be specified here. All translation files need to be stored in .json format inside the "translations" folder of the extension's project folder.

service

This key stores the name of the Zoho product for which the extension is created.

storage 

At times, there may be a need for you to store data and use it whenever needed in your extension. This can be accomplished by enabling data storage for your extension. Set the value to "true" to enable the feature. It is disabled by default.

whiteListedDomains 

When you build an extension that integrates Zoho Desk with a third-party application, you will be invoking APIs. The domain names of these APIs have to be authorized by Zoho Desk and whitelisted to ensure a secure data transfer between the two applications.
 
Only whitelisted domains can be used to make an API call. Requests for domains that are not included in this key will be blocked. If your extension does not include third-party service requests, this key is declared as an empty array.

widgets

The details regarding widgets created for the extension are added to this key. An extension can have multiple widgets and the details can be added here as an array of objects. The following are the parameters that construct a widget object:
 
  • location: The information about where to load a widget needs to be added here. All locations where the widget could be loaded are predefined.  
  • url: The path of the widget's html file can be added here, either as a relative path (for internally hosted extensions) or an absolute path (for externally hosted extensions).
  • name: Name of the extension (displayed in the extension header)
  • logo: Path of the extension's logo (displayed in the extension header)
  • icon: Path of the extension's icon (displayed only on the widget chat bar and subtab)
Our next post will continue with the authorization part of configuration.
 
Stay tuned!


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

                                  • Announcing Kiosk 1.1 - Customize screen titles, configure new fields & actions, use values from your Kiosk to update fields, and more.

                                    Hello all We are back again with more enhancements to Kiosk. So what's new? Enhancements made to the Components Add titles for your Kiosk screens and adjust its width to suit your viewing preferences. Three new fields can be added to your screen: Percentage,
                                  • Any recommendations for Australian Telephony Integration providers?

                                    HI,  I am looking for some advice on phone providers as we are looking to upgrade our phone system, does anybody have experience with any of the Australian providers that integrate with CRM Telephony? So far we are looking at RingCentral and Amazon Connect, and would love to hear feedback on any of the other providers you might have tried.  Thank you
                                  • Zoho Campaigns Workspaces

                                    Hi, I’m currently working on a Zoho CRM + Zoho Campaigns setup for a franchisee-based organization, where each franchise must only see and use its own contacts. At the moment, franchisees cannot properly access their contact lists in Zoho Campaigns unless
                                  • Newsletter in multiple languages

                                    Hi We are planning on starting to use Zoho Campaigns for our newsletters. Since we send our newsletters in three languages, I would need the "unsubscribe page" and other pages related to the NL (Thank you page and so on) to be available in different languages
                                  • Fixed assets in Zoho One?

                                    Hi, We use Zoho Books and have the fixed asset option in it. I started a trial for Zoho One and I do not see that as an option. Is the books that is part of zoho one equivalent to Zoho Books Elite subscription or is it a lesser version? Thanks, Matt
                                  • Set Default Status of Assembly to "Assembled" When Entered in UI

                                    I've just discovered the new "confirmed" status of Assemblies within Inventory. While I understand the intent of this (allowing for manufacturing planning and raw material stock allocation), it was initially confusing to me when manually entering some
                                  • I need to Record Vatable amount and non vatable amount separately in zoho books in a single line

                                    I need to Record Vatable amount and non vatable amount separately in zoho books in a single line give me the customisation option and in invoice copy to customer the total amount should be inclusive 5%vat and no need to show the vatable and non vatable
                                  • Sort Legend & stacked bar chart by value

                                    I'd love to see an option added to sort the legend of graphs by the value that is being represented. This way the items with the largest value in the graph are displayed top down in the legend. For example, let's say I have a large sales team and I create
                                  • Scanned Doc - selecting Item overwrites Rate

                                    I have a Vendor Invoice which was uploaded to Documents. I select Add To > New Bill. The OCR is actually quite good, but it is reading an Item Description instead of an Item Number. I remove the description and select the correct Item Number... and it
                                  • Timesheet invalid data error

                                    Getting the "Invalid Date" error when trying to add a time sheet to an appointment in a work order. I initially though the work order was corrupt or something so I deleted the work order and recreated it. I added the first time sheet to the AP and saved
                                  • Any update on adding New Customer Payment Providers who support in store terminal devices?

                                    Currently there is only one Customer payment provider listed for terminal devices in USA- Everyware. They charge a monthly fee of almost $149 minimum. Will you add other providers - like Zoho Payments or Stripe or Worldpay that would allow integrated
                                  • "Temporary" Field Value?

                                    I have a custom action in Form A report Detail View that passes the Rec ID and updates a Temp Record ID lookup field in the Form B record via openURL (and opens the Form B report in popup) . The updated Temp Record ID field value in Form B is then used
                                  • File Upload field automatically replaces spaces with underscores – support experience

                                    Hi everyone, I want to share my recent experience regarding the File Upload field behavior in Zoho Creator and my interaction with the Zoho support team. When a user uploads a file, the system automatically renames the document by replacing spaces in
                                  • We Asked, Zoho Delivered: The New Early Access Program is Here

                                    For years, the Zoho Creator community has requested a more transparent and participatory approach to beta testing and feature previews. Today, I'm thrilled to highlight that Zoho has delivered exactly what we asked for with the launch of the Early Access
                                  • Queries on Project-Based Inventory Consumption and Proforma Invoice in Zoho ERP

                                    We would appreciate your clarification on how Zoho ERP plans to handle the following: Project-based inventory consumption without itemized sales orders Accurate project cost tracking along with inventory reduction Proforma Invoice usage We look forward
                                  • Applying Excess Payments & Conflict Invoices Due to Cancelled Items

                                    I’m running into several issues that appear to stem from deeper-than-expected overlap between Zoho Finance (Books/Inventory) and Zoho POS. The level of coupling between these systems seems greater than what was originally communicated, and it’s leading
                                  • Zoho Sprint Backlog View, filter by item status

                                    Hello, In Zoho Sprints, it would be great to be able filter out specific items in the Backlog based on their status. We would like to track items that were Removed from our backlog without seeing them constantly in the Backlog view, as this view should
                                  • WATERFALL CHART IN ZOHO ANALYTICS

                                    Hi Team, I would like to know whether Zoho Analytics currently supports a Waterfall Chart as a built-in visualization type. If yes, could you please share the steps to create one? If not, is there any workaround or recommended method to build a Waterfall
                                  • Export contacts from Bigin's mobile app to your Android device

                                    Hello everyone! We're happy to announce that you can now export customer contacts from the Bigin mobile app to your device. Scenario A small-scale business owner has two pipelines in Bigin—one for procuring raw materials and the other for selling his
                                  • ASAP iOS SDK – Xcode Compatibility Update

                                    Hello everyone, We have been delivering the ASAP iOS SDK developed using Xcode 16.1 to provide Help Center support within mobile applications. Thus, ASAP iOS SDK versions upto 4.5.8 are compatible with development environments running in Xcode 16.1 and
                                  • Sub form auto field population based on parent form

                                    I have a parent form called "Sites" with a text field called "Site". I have a subform called "Design Comments" (actual form name "Review Comments") with a lookup field name "Sites1" that looks up from the Sites form. I want the Sites1 lookup field to
                                  • Not able to import transactions from Razorpay

                                    Hi, tried implementing Razorpay integration with books,also added a webhook, but while this added a razorpay clearing account it does not have any data in it. Neither is it getting updated with new transactions happening on Razorpay. This problem is compounded
                                  • A note-taking app right inside your project management space

                                    How do you feel when you check off the last task from your to-do list after a long day at work? Euphoric, blissful, satisfied? Now, imagine completing the same checklist from your PM platform, without juggling tools. Sounds simple and handy? That’s exactly
                                  • Email Forwarding: Maintain business continuity

                                    As an administrator, ensuring uninterrupted email communication is critical when a role-based employee is unavailable due to extended leave or a temporary role change. Emails from customers, partners, and internal teams must continue to be received and
                                  • Tip #61- Collaborate live with Invite Technician- 'Insider Insights'

                                    Hello Zoho Assist Community! From the series of Technician Console, we will be exploring Session. Let's jump right into a brief overview. We’ve all been there: you’re deep into a complex remote session, and you realize you need a second pair of eyes.
                                  • How to integrate Zoho CRM, Zoho Forms and a WIX Web Site

                                    Attached video demonstrates how to use Zoho Forms included in Zoho One, to design a Contact Us form to be embedded into a WIX web site and integrated into Zoho CRM.
                                  • Bug Causing Major Sync & SO Access Failures in Zoho POS

                                    We are experiencing critical and recurring issues in Zoho POS that all trace back to role-permission handling defects in the latest POS app version. These issues directly affect syncing, login ability, and Sales Order access for role-restricted users
                                  • Add Custom Reports To Dashboard or Home Tab

                                    Hi there, I think it would be great to be able to add our custom reports to the Home Tab or Dashboards. Thanks! Chad Announcement: The feature is being rolled out across DC's and Edition in phases. To know more refer to the announcement post here.
                                  • How to block whole domain?

                                    I am getting at least 50-75sometimes over 100 spams emails a day. I see a lot of the spam is coming from .eu domains. I would like to block /reject all email coming for the .eu domain. I do not have any need for email from .EU domains. Why won't the BlackList
                                  • Hiding Pre-defined Views

                                    You can enhance Zoho with custom views - but you cannot hide the pre-defined views. Most users focus on 4 or 5 views. Right now for EVERY user EVERY time they want to move to one of their 4 or 5 views - they have to scroll down past a long list of pre-defined
                                  • why can't agent see accounts & contacts

                                    My new user, with 'Agent' privileges, cannot see records that don't belong to them. How can I give them access? Why isn't this the default configuration in Zoho?
                                  • 【Zoho CRM】フィルター機能のアップデート:ルックアップ項目を使ったデータフィルタリング

                                    ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 今回は「Zoho CRM アップデート情報」の中からフィルター機能のアップデートをご紹介します。 ルックアップ項目を使ったデータフィルタリングがより詳細に行えるようになりました。 この機能は詳細フィルターとカスタムビューで利用でき、必要な情報を正確に取得できます。 これにより、タブ間を移動することなく、より深く正確な方法でデータを絞り込むことが可能になります。 ◉できること 詳細フィルターとカスタムビューで、ルックアップ先タブの項目が選択可能
                                  • Zoho Books | Product updates | July 2025

                                    Hello users, We’ve rolled out new features and enhancements in Zoho Books. From plan-based trials to the option to mark PDF templates as inactive, explore the updates designed to enhance your bookkeeping experience. Introducing Plan Based Trials in Zoho
                                  • Zoho Books | Product updates | August 2025

                                    Hello users, We’ve rolled out new features and enhancements in Zoho Books. From the right sidebar where you can manage all your widgets, to integrating Zoho Payments feeds in Zoho Books, explore the updates designed to enhance your bookkeeping experience.
                                  • Weekly Tips: Protect Confidential Information with PGP in Zoho Mail

                                    We deal with confidential information almost every day, whether it is being sent out or received. Though emails sent using Zoho Mail are encrypted both during transit and at rest, attempts to access and steal your sensitive data are always a threat that
                                  • Quotes Approval

                                    Hey all, Could you please help in the following: When creating quotes, how to configure it in a way, that its approval would work according to the quoted items description, not according to quote information. In my case, the quote should be sent to approval
                                  • Important Update: Facebook Pages API Deprecation

                                    Dear Zoho Analytics users, As of January 26, 2026, Facebook has officially deprecated Facebook Pages API version 18. This update involves the removal of several metrics that were previously supported by the API. As a result, these changes will affect
                                  • Adding a Deal to and Existing Contact

                                    I want to easily add a Deal to an existing Contact. If I click on New Deal on the Contact page this currently this is what happens: All of the mandatory field (and other field) information exists within the Contact. Is there a simple way for it to automatically
                                  • Default font size for printing is too big

                                    A recent issue in printing e mails is that the default font size is huge. This happens in both Edge and Firefox. In order to get what I would call a "normal" printout of an e mail it is necessary to go into the printer preferences / options and set the scale to 75%, otherwise a short e mail with signature and logos etc printed at 100% can take 3 or 4 pages. The annoying thing is that it is necessary to do this each time a printout is to be made as a change in scale only applies to that particular
                                  • Custom SMTP is now available in Zoho Sign

                                    Hi there! Want to send Zoho Sign emails from your organization's or personal email server? Look no further! Zoho Sign has introduced custom Simple Mail Transfer Protocol (SMTP) for Enterprise users across all data centers. By enabling custom SMTP, you
                                  • Next Page