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




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

                                                                                            Get Started. Write Away!

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

                                                                                              Zoho CRM コンテンツ






                                                                                                Nederlandse Hulpbronnen


                                                                                                    ご検討中の方




                                                                                                          • Recent Topics

                                                                                                          • New Toolbar in Zoho Sheet

                                                                                                            We have revamped our toolbar design in this new version of Zoho Sheet. Below are some screenshots to help you get accustomed to this new interface. Click on the picture below to view the animated image in its original size. Scroll down this post to learn about the changes. Highlight of Changes: The previous format tab is now split into 2 tabs - Home and Format. The Home tab contains the commonly used functions and the Format tab holds formatting related options. Under the Home tab towards the far
                                                                                                          • Zoho Projects - Task Owner filter at Project level

                                                                                                            Hi Projects Team, The feature requests I would like to raise is the ability to create a custom view at the project level for projects with tasks owned by a user or users. For example "Ashley's Projects" custom view might contain a list of project in which
                                                                                                          • Zoho inbuilt Telephony made a lot of issues!

                                                                                                            Hi there, I am a user that I am working with zoho inbuilt telephony around 1 month. Non of my colleagues are happy with this app! most of the time customer cannot hear my customer service team, customers say our voice is breaking. whenever Telephony support
                                                                                                          • Sending workflow notifications using popular chat services

                                                                                                            Hello everyone, We have introduced instant and scheduled notifications on some of the most popular chat platforms to facilitate easy collaboration, quick action, and wider reach. Workflow notifications can be sent to the following chat platforms: Zoho
                                                                                                          • Webhook not firing.

                                                                                                            I created a webhook using the Web UI, it looks very nice and the testing worked without an issue, but when i save/ update a ticket, the webhook is not firing. Here are the details of the web-hook i get from using the API "modifiedTime": "2019-10-22T09:23:37.380Z",
                                                                                                          • Adding Images to a Quote in Zoho CRM

                                                                                                            We are currently preparing to use Quotes in Zoho CRM and we are building out our Quote templates.  We came across an issue of not being to add Images of the products to the Quote - specifically in the body of the Quote templates.   This is a problem,
                                                                                                          • Applications built with Zoho Creator

                                                                                                            Hi, I’m really interested in seeing how others have built their application using Zoho Creator, especially those designed for external users (clients, vendors, or the public). If you’ve developed something along those lines and don’t mind sharing, I’d
                                                                                                          • In arattai received message can't be deleted

                                                                                                            The issue has been noticed in following: arattai app (Android) arattai app (Window) arattai web While the message posted by me may be deleted, the ones received from others can't be. The item <Delete> change to <Report> when the message is a received
                                                                                                          • Is it posssible to add Asap Widget on Wordpress?

                                                                                                            I have tried to add the ASAP widget so users could iniciate chats and see the KB information but nothings seems to work. I have tried to add the script using a php snippet that adds the to the footers and also tried one for the header in the functio
                                                                                                          • Require ticket resolution

                                                                                                            Hi Zoho team, Is there a way to require resolution even if an agent did not use a blueprint? for example, our blueprint has a "resolve" transition but what if agent revoked blueprint and manually set the status of ticket to closed? Is there a way where
                                                                                                          • Tables from ZohoSheets remove images when updated from source

                                                                                                            I have a few tables from a ZohoSheet in a ZohoWriter document that will remove the images in the cells when I refresh from the source. The source still has the images in the table when I go to refresh. After updating from the source, as you can see the
                                                                                                          • Unable to Receive Emails on Zoho Mail After Office 365 Coexistence Setup – Error: 553 Relaying Disallowed

                                                                                                            Hello, My domain name is bigniter.com, and I’ve been using Zoho Mail as my email service provider without any issues. Recently, I followed the steps outlined in the Zoho documentation to enable Coexistence with Office 365: 🔗 https://www.zoho.com/mail/help/adminconsole/coexistence-with-office365.html#multi-server
                                                                                                          • API Pagination Error: 'from' Parameter Limit

                                                                                                            Hello, I am encountering an error while paging through the Zoho Desk API results: Status code: 422 - {"errorCode":"UNPROCESSABLE_ENTITY","message":"The value passed for field 'from' exceeds the range of '0-4999'."} Is 5000 the maximum number of records
                                                                                                          • How to go to the next open ticket in the queue when agents closes ticket

                                                                                                            Zoho Desk When agent closes a ticket - eg when they choose 'Send and Close" - where is the setting that automatically redirects them to the next open ticket in the queue?
                                                                                                          • External download link limit

                                                                                                            Can You please help us to understand this For Zoho WorkDrive external users, the download limit is a maximum of 5 GB total download size and a maximum of 50 first-level files and folders What is the meaning of first level? We are using these files in
                                                                                                          • CRM verify details pop-up

                                                                                                            Was there a UI change recently that involves the Verify Details pop-up when changing the Stage of a Deal to certain things? I can't for the life of me find a workflow or function, blueprint, validation rule, layout rule ect that would randomly make it
                                                                                                          • Automatically Add Recurring Zoho Meeting Events to Zoho Calendar / Zoho Meeting Calendar

                                                                                                            Hello Zoho Meeting Team, Hope you are doing well. We would like to request an enhancement regarding recurring meetings created inside Zoho Meeting. At the moment, when we schedule a recurring meeting in Zoho Meeting, it does not appear in Zoho Calendar
                                                                                                          • The difference between Zoho Marketing Automation and Zoho Campaigns

                                                                                                            Greetings Marketers! This post aims to differentiate between Zoho Marketing Automation and Zoho Campaigns. By the time you get to the end of the post, you will be able to choose a product that objectively suits you. What is Zoho Marketing Automation?
                                                                                                          • Custom templates for calendar report

                                                                                                            What about being able to design custom templates for the calendar report, as well as for other types of reports? I think more users are waiting for this.
                                                                                                          • Print a price list or price book

                                                                                                            Hi Community. Am I right in concluding that Zoho has no functionality to print a price list from either Zoho CRM, Zoho Inventory or Zoho Books? I won't get stuck on the fact that Zoho doesn't sync price books between Zoho CRM and Books/Inventory (more
                                                                                                          • Disable payment thank-you emails

                                                                                                            Hello, can someone please tell me how to disable sending of the "Payment Thank-You" emails? 
                                                                                                          • Maximum tags possible in Contacts Records

                                                                                                            I read in some documentation that Zoho allows a total of 200 tags across all records. Is this correct? So is it not possible to have one tag per record for 500 records?
                                                                                                          • Integrate your Outlook/ Office 365 inbox with Zoho CRM via Graph API

                                                                                                            Hello folks, In addition to the existing IMAP and POP options, you can now integrate your Outlook/Office 365 inbox with Zoho CRM via Graph API. Why did we add this option? Microsoft Graph API offers a single endpoint to access data from across Microsoft’s
                                                                                                          • Any way to "Pay with Check" or "Refund with Check" for Credit Notes?

                                                                                                            When we have a Bill in Zoho Books, we can select the "Pay with Check" option which then allows us to print/cut the check directly out of Zoho Books. When we created a Credit Note and want to refund the customer, is there any way to Refund with Check,
                                                                                                          • CRM Mobile reports

                                                                                                            When our engineers finish a job they like to email the customer a job report. This is best done todate as an email template but we can find no way to include an image field from that module. Is there any other options?
                                                                                                          • When Zoho Tables Beta will be open to EU data center

                                                                                                            Hello all, We in EU are looking at you all using and testing and are getting jealous :) When we will be able to get into the beta also? We don't mind testing and playing with beta software. Thank you!
                                                                                                          • Start Form on a different page (i.e., hide form pages)?

                                                                                                            I have a Zoho form that uses the `Field Alias - Prefill URL` feature. My goal is to have a pre-filled field that directs the user to a specific starting page in the form. For example: The URL will have a field alias that will auto-populate a field with
                                                                                                          • Microsoft Teams now available as an online meeting provider

                                                                                                            Hello everyone, We're pleased to announce that Zoho CRM now supports Microsoft Teams as an online meeting provider—alongside the other providers already available. Admins can enable Microsoft Teams directly from the Preferences tab under the Meetings
                                                                                                          • Standard Payment Term is not pulled from account to quotation

                                                                                                            Hey Team There seems to be something off. I do have "Net 30" as my default payment term in Zoho Books for my customers. If, from the customer overview or quote section, I create a new Quotation, the payment terms field stays blank and doesn't get the
                                                                                                          • Passing the CRM

                                                                                                            Hi, I am hoping someone can help. I have a zoho form that has a CRM lookup field. I was hoping to send this to my publicly to clients via a text message and the form then attaches the signed form back to the custom module. This work absolutely fine when
                                                                                                          • How can we disable "My Requests"?

                                                                                                            We are not using this functionality in our system at all and our users get confused.
                                                                                                          • PayPal payment received recording problem

                                                                                                            Hi, A little while back one of our customers used the PayPal payment option to pay an invoice For some reason though the payment is showing up twice within the Payments section of the invoice! Instead of setting the invoice value to ZERO, it now shows a negative value Anyone else face this problem? I've checked PayPal and there is only 1 payment in reality... A bug? Actonia ps: for anyone from Zoho Customer Service or tech team,  its Invoice 785 in our account
                                                                                                          • string(87) "{"code":"INVALID_TOKEN","details":{},"message":"invalid oauth token","status":"error"} " grtting this error

                                                                                                            Using access token i am trying to add sales orders through api but it is throwing errors like the above i have mentioned. Please help me for that
                                                                                                          • How to mute chat notification sound by default in Zoho SalesIQ?

                                                                                                            We’ve recently embedded the Zoho SalesIQ chatbot on our website, and we’ve noticed that notification sounds sometimes play even when the visitor hasn’t interacted with the chat widget yet. We’re trying to understand two things: Why do these sounds occur
                                                                                                          • Kanban View for Projects.

                                                                                                            At our organization, we describe active projects with various statuses like "In Proofing" or "Printing" or "Mailing". In the Projects view, one can set these project statuses by selecting from the appropriate drop-down. While this works, it's difficult to view and comprehend the progress of all of your projects relative to each other in a table. Creating a Kanban view for projects where I can move them from one status to another allows me to see where each project is in the order of our workflow.
                                                                                                          • How to Hide Article Links in SalesIQ Answer Bot Responses

                                                                                                            I have published an article in SalesIQ, and the Answer Bot is fetching the data and responding correctly. However, it is also displaying the article link, which I don’t want. How can I remove the link so that only the message is shown?
                                                                                                          • Currency limitation when integrating Zoho CRM & Zoho Books

                                                                                                            Brief Video of Problem: https://www.loom.com/share/d61d1d07d0904e149d80c1901a22418e. Background ·       Our business is based in Australia and we have to have Zoho Books in AUD to comply with tax and reporting regulations in Australia. ·       We sell
                                                                                                          • Add RECURRING option when adding email to calendar events

                                                                                                            When you add an email to a calendar event, there is no option to make that new calendar event into a recurring event.  It is counterproductive to make an event from your email to then have to go to your calendar, find the event, and make it recurring. 
                                                                                                          • Using Contains as a filter

                                                                                                            We are using Zoho Reports, ServiceDesk Plus analytics. I do not see how to create a report filter using Contains comparison of a string values, is one string contained in another. For example, Task Title contains the word Monitor. Is this possible in Zoho Reports?  This reporting feature is available in SDP reporting. Thanks in advance, Craig Rice
                                                                                                          • LINE Auto Message Connect to Zoho

                                                                                                            When I integrated LINE into the CRM, I was prompted to disable “Chat,” “Auto Response,” and “Greeting Messages,” and to enable the webhook. However, since I have already set up some auto-reply features in LINE, including Rich Messages and greeting automation,
                                                                                                          • Next Page