Building Extensions #7: Configuration setup while building extensions - Part 3

Building Extensions #7: Configuration setup while building extensions - Part 3

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 discussed on establishing a default connection between Zoho Desk and other Zoho or third-party services and authenticating them. This post will continue by discussing on establishing a custom connection between Zoho Desk and third-party services, which are not available in the default services list. To connect with a service that is not in this list, you can create a new service in the Custom Service tab under Connections in Sigma. A new connector for the requested service will be created and listed for use.

To configure a custom connection:
  1. Navigate to the Sigma workspace.
  2. Choose Connections from the left panel.
  3. Under Create Connection, click on the Custom Service tab.
  4. Click on Create Your Own under Custom Service.
  5. Under Service Details, provide the following information:
    • Service Name: This is the display name of the service that you want to create.
    • Service LinkName: Link name to help you to uniquely identify your custom service.
    • Authentication Type: Choose from the dropdown menu of authentication types based on the desired service's API documentation, and enter the subsequent fields corresponding to that type. Learn more about authentication types.
  6. Under Connection Details, provide the following information:
    • Connection Name: The display name of your connection.
    • Connection LinkName: Link names must be unique and can be used in Deluge integration tasks and invoke URL scripts to establish authentication.
    • Scope (applicable only to OAuth 2 auth type): Scopes required to perform integration as specified in the desired service's API documentation.
    • Check Use Credentials Of Login User if you want every user to enter their service credentials to log in. If not checked, the admin login is sufficient for all users.
    • Scope Delimiter (applicable only to OAuth 2 auth type): Delimiter with which the desired service API expects the scopes to be separated.
      d
  7. Click Create and Connect.
  8. On the Connection Summary page, click the JSON tab.
  9. Copy the code snippet and paste it into the plugin-manifest.json file within connectors.
Upon successful authorization, the connection will be created and listed in your connections page under Own Connections. The configured service will be listed under Custom Service.


  1. {
  2.    "locale":[
  3.       "en"
  4.    ],
  5.    "service":"DESK",
  6.    "storage":false,
  7.    "type":"personal",
  8.    "whiteListedDomains":[
  9.       "https://content.dropboxapi.com%26quot%3B]%2C/"
  10.    ],
  11.    "modules":{
  12.       "widgets":[
  13.          {
  14.             "location":"desk.ticket.detail.rightpanel",
  15.             "url":"/app/widget.html",
  16.             "name":"Desk Extension",
  17.             "logo":"/app/img/logo.png",
  18.             "icon":"/app/img/icon.png"
  19.          }
  20.       ]
  21.    },
  22.    "zohoAuthorisation":{
  23.    },
  24.    "connectors":[
  25.       {
  26.          "connectionLinkName":"dropbox_for_zoho_desk",
  27.          "connectionName":"Dropbox for Zoho Desk",
  28.          "serviceName":"dropbox",
  29.          "userAccess":true,
  30.          "isUserDefinedService":false,
  31.          "sharedBy":"4241905"
  32.       }
  33.    ],
  34.    "config":[
  35.    ],
  36.    "moduleSupport":true
  37. }


    Access your files securely from anywhere







                            Zoho Developer Community





                                                  Use cases

                                                  Make the most of Zoho Desk with the use cases.

                                                   
                                                    

                                                  eBooks

                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho Desk.

                                                   
                                                    

                                                  Videos

                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho Desk.

                                                   
                                                    

                                                  Webinar

                                                  Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                   
                                                    
                                                  • Desk Community Learning Series


                                                  • Meetups


                                                  • Ask the Experts


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner






                                                            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 Writer

                                                                                              Get Started. Write Away!

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

                                                                                                Zoho CRM コンテンツ








                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                            • Recent Topics

                                                                                                            • Is it possible to edit placeholder text?

                                                                                                              In the master slides I want to make sure my templates have more meaning for the users and want to replace the standard placeholder text with something more instructional. Instead of "Click to edit Mast subtitle styles" I want to have "Click to enter reporting
                                                                                                            • Delay function execute

                                                                                                              I've got a workflow which uses a webhook to send information to Flow, which in return updates a record in Creator. Problem is, by the time this has executed, the rest of my script has run and can't find the (yet to be) updated info in the record. Is there
                                                                                                            • Refunds do not export from Shopify, Amazon and Esty to Zoho. And then do not go from Zoho inventory to Quickbooks.

                                                                                                              I have a huge hole in my accounts from refunds and the lack of synchronisation between shopify , Amazon and Etsy to Zoho ( i.e when I process a refund on shopify/ Amazon or Etsy it does not come through to Zoho) and then if I process a manual credit note/
                                                                                                            • How to allow download of a file AFTER information is collected?

                                                                                                              I can't find this anywhere. Can someone help with what seems to be a pretty basic web function today? - File is stored in Workdrive - Prospect goes to a URL where the file is located - System requests prospect to enter "Name" and "Email" - An email is
                                                                                                            • Email Reminders on Shared Calendars

                                                                                                              How do we turn off the setting that emails reminders to everyone who has accepted or declined a calendar invite? If 8 of us have been invited to the same meeting, we receive 8 notifications for every step of the process, from invitation to decision.
                                                                                                            • Bulk Fill In & Edit PO/Bill/SO/Invoice

                                                                                                              Hello, I am adding stock in bulk on a PO, the system is automatically populating the Rate (price) and Tax from the item data. Problem is that the bill rate is different from the rate on the item data, so I have to manually erase each and enter the price.
                                                                                                            • Fixed Assets beg balance

                                                                                                              Hello, I trust you are well I'm a new zoho books user and I find it difficult to plug in the fixed assets balance and here's what I have done: 1- I imported the fixed assets data into the fixed assets module as per the instructions 2- the import process
                                                                                                            • Syncing with Google calendar, Tasks and Events

                                                                                                              Is it possible to sync Zoho CRM calendar, task and events with Google Calendar's tasks and events. With the increasing adoption by many major tool suppliers to sync seamlessly with Google's offerings (for instance I use the excellent Any.do task planning
                                                                                                            • CRM Deluge how can link attach file with workdrive file.

                                                                                                              Hi, We have create file at workdrive and would like to link to attachment at crm module by deluge. Right now can only upload it to attachment but can not link the file from workdrive. Thank you
                                                                                                            • Feature announcement: AI-powered document generator in Zoho Sign

                                                                                                              Hi there! We recently announced manual document creation by offering an editor within Zoho Sign. Today, we are excited to announce AI-powered document generation to help you draft agreements, purchase orders, and other important business documents in
                                                                                                            • Permanently deleted files

                                                                                                              Is there a way to get back permanently deleted files from your account if they were accidentally deleted and no longer recoverable from the recycling bin? I know I am probably screwed but I just figured I would ask.
                                                                                                            • Shared Mailbox in iOS app

                                                                                                              Hi, On the desktop I am using a Shared mailbox for our company's general mailbox that somebody else should be able to view. In the iOS app however I can't find it? Old sources on the internet says this isn't possible but that can't be right? Somebody
                                                                                                            • Tip #41- Simplify Compliance and Efficiency with Zoho Assist’s Data Cleanup Feature- 'Insider Insights'

                                                                                                              Managing device data efficiently is just as important as securing remote access. With Zoho Assist’s Data Cleanup feature, admins can easily remove outdated or unnecessary device records, keeping the console organized and secure. This action is carried
                                                                                                            • Revenue Management: #6 Revenue Recognition in Professional Services Industry

                                                                                                              If you run a consulting firm, agency, or any service-based business, you have a situation where you have signed the contract, maybe even sent the invoice, and have received some initial payments. So, can you consider this as revenue? What if the project
                                                                                                            • This domain is not allowed to add. Please contact support-as@zohocorp.com for further details

                                                                                                              I am trying to setup the free version of Zoho Mail. When I tried to add my domain, theselfreunion.com I got the error message that is the subject of this Topic. I've read your other community forum topics, and this is NOT a free domain. So what is the
                                                                                                            • Zoho fsm scheduled maintenance dispatch

                                                                                                              Hi, I'm reaching out regarding an issue I'm encountering with the Scheduled Maintenance feature in Zoho FSM. I’m trying to configure it so that it automatically dispatches all maintenance jobs scheduled within the next 150 days, starting from today. However,
                                                                                                            • Template modifiactions

                                                                                                              Hello, I am struggling with the templates in ZOHO Books. Especially with the placement of some items, like company address, ship to, bill to etc.  For example: One item I like from template X (placement of ship to and bill to next to each other in the
                                                                                                            • zoho.inventory.getRecords returns no records

                                                                                                              I running a custom function (Deluge) in Zoho Flow with a connection to Zoho Inventory. To debug the problem, I created the test function below. It returns "Number of contacts fetched: 0". This confirms that there's no issue with the org ID or connection
                                                                                                            • How do I get Status History data of my Projects?

                                                                                                              I want to build a table in Zoho Analytics that Groups by Date, when Projects entered a certain status. I cannot find Status History or any such useful data available in the Setup of my Data Source sync. Please advise how I can achieve this?
                                                                                                            • Zoho Campaigns Event timestamps do not propagate to Zoho CRM

                                                                                                              We have integrated Zoho CRM and Zoho Campaigns. But when looking at Contact records, the Campaign event data is missing the actual timestamps: especially when a particular email was sent. They're not in the Campaigns related list, and the cannot be found
                                                                                                            • Feature announcement - Simplifying document creation with Zoho Sign

                                                                                                              Hi there, We are pleased to announce the release of our document creation feature, enabling you to create, edit, and finalize documents like agreements, purchase orders, and contracts without relying on external tools or applications. <br> This
                                                                                                            • Integrating File Attachments in Zoho Flow Email Notifications

                                                                                                              Hi, I would like to be able to send an email once an entry is made in a form, and in this email, I would like to attach a file that has been added to the form using the ImageUpload (or FileUpload) widget. So, I started by creating a flow that will trigger
                                                                                                            • CRM->INVENTORY, sync products as composite items

                                                                                                              We have a product team working in the CRM, as it’s more convenient than using Books or Inventory—especially with features like Blueprints being available. Once a product reaches a certain stage, it needs to become visible in Inventory. To achieve this,
                                                                                                            • Zoho Mail SMTP IP addresses

                                                                                                              We are using Zoho Mail and needs to whitelist IP for some redirections from your service to another e-mails. You can provide IP address list for Zohomail SMTP servers?
                                                                                                            • Zoho project purchases

                                                                                                              Hi Folks, I think having a purchase module in projects will help in putting together a project p and L. Project wise purchases and expenses.  Do let me know your thoughts.
                                                                                                            • Create Tasklist with Tasklist Template using API v3

                                                                                                              In the old API, we could mention the parameter 'task_template_id' when creating a tasklist via API to apply a tasklist template: https://www.zoho.com/projects/help/rest-api/tasklists-api.html#create-tasklist In API v3 there does not seem to be a way to
                                                                                                            • How can I restore all the deleted Time entries of a Task in Zoho Projects

                                                                                                              How can I restore all the deleted Time entries of a Task in Zoho Projects? Query: In Zoho Projects, I cloned a task and deleted the time entries from the cloned task. However, this also deleted the time entries from the original task. How can I restore
                                                                                                            • Is there a way to make an account inactive in ZoHo Desk

                                                                                                              We have a few Clients "Accounts" that we no longer do business with. It would be beneficial for them to not show up in lists. However, we want to go back and view tickets, time, etc.
                                                                                                            • How to set the value of the Phone field importing contacts in Zoho Desk

                                                                                                              Hi everyone, i'm new in Zoho Desk, we're setting up the environment and i'm importing contacts from another CRM using a file CSV and i'm getting a problem with phone numbers (italian): the leading zero is cut away, also if the value is inside double quotes.
                                                                                                            • Can we generate APK and IOS app?

                                                                                                              Dears, I want to know the availability to develop the app on zoho and after that .. generate the APK or IOS app  and after that I added them to play store or IOS store.. Is it possible to do this .. I want not to use zoho app or let my customers use it. thanks 
                                                                                                            • Set Custom Icon for Custom Modules in new Zoho CRM UI

                                                                                                            • Change total display format in weekly time logs

                                                                                                              Hi! Would it be possible to display the total of the value entered in the weekly time log in the same format that the user input? This could be an option in the general settings -> display daily timesheet total in XX.XX format or XX:XX.
                                                                                                            • Deprecation Notice: OpenAI Assistants API will be shut down on August 26, 2026

                                                                                                              I recieved this email from openAI what does it means for us that are using the integration and what should we do? Earlier this year, we shared our plan to deprecate the Assistants API once the Responses API reached feature parity. With the launch of Conversations,
                                                                                                            • How to center a field inside a section?

                                                                                                              I’ve been trying to center a field inside a section in Zoho Canvas. When I align it visually, it looks centered in the editor, but after clicking Save, the field appears misaligned on the actual canvas. I also tried setting the field to full width, but
                                                                                                            • Quick Create needs Client Script support

                                                                                                              As per the title. We need client scripts to apply at a Quick Create level. We enforce logic on the form to ensure data quality, automate field values, etc. However, all this is lost when a user attempts a "Quick Create". It is disappointing because, from
                                                                                                            • Kaizen #192 - Implementing Custom Token Persistence in Python SDK

                                                                                                              Welcome back to another week of Kaizen! Last week, we discussed how to implement Login with Zoho using OAuth 2.0 and saw how to bring it to life in a real-world application with the Zoho CRM Python SDK. We also discussed how Zylker Academy built a custom
                                                                                                            • Showing the map along with mileage expense

                                                                                                              When you use the GPS to track mileage, it shows you the map of the actual path travelled. It would be very useful and practical to save that map with the mileage expense, so that when the report is created, it provides a map of each mileage expense associated
                                                                                                            • Is there any way to recall an email sent using Zoho CRM?

                                                                                                              If an email is sent using Zoho Mail, there is a recall option/functionality that is available to the sender. Is there any way to recall an email if it was sent using Zoho CRM? I can't seem to find that option. Any help would be appreciated.
                                                                                                            • Enable Validation Rule for Multi-Select Picklist Field

                                                                                                              Zoho, Please allow validation rules for multi-select fields.
                                                                                                            • File Upload field not showing in workflow

                                                                                                              Hi, I have added a field on Zoho CRM. I want to use it in a workflow where that particular field is updated based on another field, however it is not showing up in the field list to select it in the workflow. Why is this please?
                                                                                                            • Next Page