Creating seamless integrations with connections

Creating seamless integrations with connections



Hello all,

In our last post, we gave an overview of the fundamental features available in the Zoho Sprints developer platform and the capabilities they offer in building effective extensions for Zoho Sprints.

In this post, we'll explore the feature Connections, the types of connections, and the steps to create one in detail, along with a use case.

Connections

What and when?

APIs are the core set of rules that an application provides to facilitate data exchange between apps. For API data transfer to be secure, those apps must be securely connected. Every app has an authentication mechanism in place to ensure that it's properly authorized and connected with other apps. Using the authentication mechanism, apps can be securely connected, and APIs can be used to handle data flow between them.

The Connections feature in the developer platform facilitates this secure integration between apps. It allows you to create seamless, tightly coupled integrations between Zoho Sprints and other apps, allowing for secure, synchronized data exchange with proper authentication and authorization.

Types of connections

There are two kinds of connections that can be created:
  1. Default connections: Zoho provides a default set of applications that you can simply select, provide some basic information for, and connect to.
  2. Custom connections: If the application you want to integrate with Zoho Sprints is not on the default list, or you want to make some customizations to your connection, you can create a custom service and then connect to it.
How to create a connection
  1. Go to Sigma and navigate to the Connections section in the left panel of your Sigma workspace.

  1. Choose Zoho Sprints as the service from the dropdown list, then select your Zoho Sprints organization.

  1. Click Create Connection to start creating a connection for the application you want to integrate with Zoho Sprints.
Note: Alternatively, you can also use the Default Services or Custom Services option under the Services section to access and create a default or a custom connection respectively.



Creating a default connection

Consider integrating with Zoho Projects to create tasks as work items in Zoho Sprints so that they may be managed in an agile way. In this case, you need to first check if Zoho Projects is included in the default service list. If it's available, to create the default connection, follow the steps below.
  1. Refer to the "How to create a connection" section for the first three steps to create a connection.
  1. Select the Default Services tab.
  1. Check for Zoho Projects in the service list by simply searching for it.

  1. Once located, click on the service. You will be redirected to the page where you must enter your connection details.
➤ Enter the connection name. The connection link name will be automatically filled in.
➤ Toggle Yes to Use Credentials of Login User if you want every user who installs the extension to authorize the connection using their credentials. Otherwise, toggle No to have only the admin authorize the connection once.
➤ Select the scopes for the APIs required to enable your extension's functionality.
➤ Click Create and Connect.
  1. The connection will be established successfully, and sample JSON code will be generated, which must be specified in the extension's plugin-manifest.json file before it can be used to invoke Zoho Projects APIs within the extension.

Note: If you want to use the Zoho Sprints APIs within the extension, you can establish a default connection for Sprints, configure it in the plugin-manifest.json file, and use it to access the Zoho Sprints APIs.

We'll look at how to configure and use the established connection in an extension later. Now that we've seen how to set up a default connection, let's move on to the processes for creating a custom connection with an example.

Creating a custom connection

Consider the following scenario: Zoho Sprints is used to manage the development and testing operations of an organization's internal team. The testing team reports a bug-related work item and notifies the developer. The developers may want to reproduce and resolve the issue with the tester via a remote or screen sharing session, which can be managed using Zoho Assist, a tool designed to assist users with these sessions.

In this situation, it would be ideal to have Zoho Assist integrated into Zoho Sprints so that a workspace user could start an Assist session with another user directly from the bug work item itself. Additionally, it would be efficient to add a comment with session details as part of the work item for future reference. To do this entirely in an extension, we need to do these key tasks:
  1. Create connections
  2. Create an extension and configure the plugin-manifest file
  3. Create a widget to start an Assist session from within a work item and add a comment to it.
1. Create connections

Since Zoho Assist isn't available in the default services list, let's go ahead create it as a custom service and connect with it. Refer to the "How to create a connection" section for the first three steps to create a connection, then proceed with the steps below to create a custom connection.
  1. Select Custom Services.
  2. Click the Create New Service option.

  1. You'll be redirected to a page where you need to enter your connection details.
➤ Enter the Service name. The service link name will be automatically filled in.
Choose the authentication type of the service you are creating the connection for. The parameter type and grant type options get populated depending on the authentication type chosen. The screenshot below displays the values chosen for the Zoho Assist service example based on its authentication mechanism.


➤ Next, provide the client credentials (obtained by creating an app in the Zoho API console).
➤ Enter the scopes of the Zoho Assist APIs required for your extension's functionality.
➤ Click Create Service.

  1. The service will be successfully created, and you'll be taken to a page where you can now go ahead and create a connection. In this page, you'll have to enter the details just like you provided connection details for your default connection.
  1. Enter a connection name, toggle Yes or No to Use Credentials of Login User, select the scopes, and click Create and Connect.

  1. You'll be asked to authorize the connection and provide access to your data for the scopes included. Accept and proceed.
  2. The connection will be successfully created and a sample JSON will be automatically generated.

  1. Since our example involves adding a comment to the Sprints work item as well, we'll be invoking the Sprints API for it. To access its API, a connection for Zoho Sprints is also required. This can be created as a default connection using the method shared in the earlier section.


2. Create an extension and configure the plugin-manifest.json file
  1. Navigate to the Extensions section in the left panel of your Sigma workspace.
  2. Click the New Extension button and create a new extension. You can refer to this post for detailed guidance on creating a new extension.
  3. In the plugin-manifest.json file of your extension, include the sample JSON code that was generated for the Zoho Assist connection you created. Also include the JSON code for the Sprints connection you created.


Now the connections are configured within the extension and can be accessed in it.

3. Create a widget to start an Assist session from within a work item and add a comment to it
  1. Create a file called createsession.html inside the app folder to render and handle the logic of your widget.
  2. This widget has to be configured in the plugin-manifest.json file with the following details.
name: The name of the widget: "Zoho Assist Session"
location: The location in which the widget needs to be rendered. This widget's location is in the work item's right navigation bar.
url: The URL path of the createsession.html file in the folder structure which renders the widget's user interface.


createsession.html - The HTML code for the widget is added as an attachment to the post.

➤ In the attached code snippet, we have invoked the Zoho Sprints API to fetch the list of Sprints workspace users. This user list is populated as a dropdown list to let the person accessing the widget choose the user they want to enter into an Assist session with. This API is invoked using a default connection created for Zoho Sprints.
➤ Next, the Zoho Assist API is used to start and create a session with the chosen user. The custom connection created for Zoho Assist is used to invoke this API.
➤ Finally, another Sprints API is invoked to add a comment that includes the session details to the work item.
  1. Now, you can test the widget using the Run option in the Sigma cloud editor. For detailed guidance on testing the extension, read our post here.
  2. Once you enter into the test environment, install the extension and authorize the connections.

  1. Next, enter into the work item and access the Zoho Assist Session widget. Choose the user and session type, and click Start Session. The session will be successfully initiated and a comment regarding the session details will also be added to the work item.


In this post, we have successfully explored connections, their types, and the detailed steps to create them along with an example. We hope you found this information useful. Keep following this space for more updates!

SEE ALSO





    Access your files securely from anywhere

        Zoho FSM Video Tutorials


              All-in-one knowledge management and training platform for your employees and customers.






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

                                                                                                                        • Dashboard Metric Drill-Down Shows Stale Data

                                                                                                                          Summary: When clicking between different metric components on a custom dashboard, the drill-down list shows data from the previously opened metric instead of the one just clicked. Steps to Reproduce: Create a custom dashboard with multiple pre-defined/templatized
                                                                                                                        • Zoho Marketing Automation WhatsApp Campaign Import Sync for Zoho Analytics

                                                                                                                          WhatsApp is a critical channel in modern marketing, yet WhatsApp Campaign metrics from Zoho Marketing Automation currently cannot be natively imported into Zoho Analytics via the default advanced analytics connector. Integrating this into the standard
                                                                                                                        • Allow Reauthorizing CRM Connections Without Revoking First

                                                                                                                          Currently, when a Zoho CRM connection needs to be reauthorized or authorized with another account, we first have to revoke the existing authorization and then authorize it again. This creates a gap where the connection is unavailable, and any functions,
                                                                                                                        • Programmatic Itemized Expenses?

                                                                                                                          It does not appear that it is possible to create itemized expenses programmatically (via the API)? Is this correct, or am I misunderstanding the situation?
                                                                                                                        • Prefix & Suffix on Single Line, Number, etc.

                                                                                                                          Hi, I would like to have the same Prefix and Suffix that was added to the Unique ID on Text and Number Fields. Use case could be as basic as temperature, as per another Idea I have to use Single Line (Text) for a number that might have leading zeros today,
                                                                                                                        • Handle Leading Zeros in a Number Field

                                                                                                                          Hi, If I use a Number Field, set with Min 7 Digits and Max 7 Digits, and enter 0000001, it will result in 1 and an error as it removes the leading zeros, the same with entering 0012340 will result in 12340 and error. So I have to use a Text Field and
                                                                                                                        • Is there a way to show contact emails in the Account?

                                                                                                                          I know I can see the emails I have sent and received on a Contact detail view, but I want to be able to see all the emails that have been sent and received between all an Accounts Contacts on the Account Detail view. That way when I see the Account detail
                                                                                                                        • Virtual Option for Fields

                                                                                                                          Hi, I would like to be able to choose another option other than Read-Only or Disabled, such as Virtual. And with Virtual, the field is shown on the form and avilable in rules, but NOT saved to the Database. A use case is having multiple Large Lists of
                                                                                                                        • Zoho Marketing Automation Cannot Sync Lookiup Fields

                                                                                                                          Hello all, It seems that Zoho MA cannot sync Lookup fields from the CRM. Can you confirm if this is the case? Is there a workaround? Do you know if Campaigns can sync with custom modules and also with Lookup field in the CRM? Thank you!
                                                                                                                        • Specific ListView Canvas on Canvas Home Page Always Loads Most Recent ListView, Not the One Specified

                                                                                                                          I had mentioned this to ZOHO, but I mainly wanted to see if others in the Community are also facing this problem. I created a Canvas ListView for a Custom Module, and then created a Canvas Home page (technically on a tab item, but I'm not sure if that
                                                                                                                        • Announcing the new SKILL.md for Zoho CRM and the updated OAS repository!

                                                                                                                          We are introducing a new zoho-crm skill to make working with Zoho CRM Developer tools (like APIs, functions, widgets, client scripts, queries etc) easier and faster, with the help of AI in your preferred AI harness like Claude Code, Codex, Cursor, VSCode
                                                                                                                        • Zoho Campaigns EU Topics API returns HTTP 200 with empty topicDetails

                                                                                                                          Hello, Our Zoho Campaigns EU organisation has two custom topics visible in the Campaigns UI, and contacts are subscribed to them. However, an OAuth request with ZohoCampaigns.contact.READ to https://campaigns.zoho.eu/api/v1.1/topics returns HTTP 200 with
                                                                                                                        • Caso de Éxito: Cómo Toyota Financial Services unificó la atención al cliente con Zoho

                                                                                                                          "Después de seis meses con el CRM en producción estamos encantados." Miriam Cárdenas, Responsable Departamento ATC Toyota Financial Services es la división financiera de Toyota encargada de gestionar la financiación de vehículos y, junto con KINTO España,
                                                                                                                        • Zoho Books - France

                                                                                                                          L’équipe de Zoho France reçoit régulièrement des questions sur la conformité de ses applications de finances (Zoho Books/ Zoho Invoice) pour le marché français. Voici quelques points pour clarifier la question : Zoho Books est un logiciel de comptabilité
                                                                                                                        • Sending Zoho form link from custom function in Zoho CRM

                                                                                                                          Hello,  We intend to send a Zoho form link to certain Contacts using a custom function. The Zoho Form must be pre-filled with the Deal information and contacts receiving it should be able to modify the values and upon submission, those modifications must
                                                                                                                        • Automatically remove commas

                                                                                                                          Team, Please be consistent in Zoho Books. In Payments, you have commas here: But when we copy and paste the amount in the Payments Made field, it does not accept it because the default setting is no commas. Please have Zoho Books remove commas autom
                                                                                                                        • Zoho ERP | Product updates | July 2026

                                                                                                                          Hello users, We're back with another round of updates to help you streamline your operations. This month's release brings new features and enhancements designed to help you work more efficiently. Read on to discover everything that's new in Zoho ERP this
                                                                                                                        • Can I hide some products from a particular customer

                                                                                                                          HI I want ot give a customer access to the portal but I need to hide some products from them that are not available for them to buy- is this possible ?
                                                                                                                        • Dashboard/Component filter by probability

                                                                                                                          Hi all Can I request the ability to add a Component or Dashboard filter for Deal Probability? Would be useful to be able to see data of deals more than 60% probable. Olly
                                                                                                                        • Admin Logging in as another User

                                                                                                                          How can a Super Admin login as another user. For example, I have a sales rep that is having issues with their Accounts and I want to view their Zoho Account with out having to do a GTM and sharing screens. Latest Update (27th April 2026): With the early
                                                                                                                        • OpenAI Is Moving to the Responses API: Here's What It Means for SalesIQ

                                                                                                                          OpenAI has deprecated its Assistants API and is moving to the Responses API. If you're using OpenAI Assistants with SalesIQ, you may be wondering if you need to make any changes to your existing setup. You don't. SalesIQ has already taken care of the
                                                                                                                        • Free webinar: Zoho Sign for Microsoft apps

                                                                                                                          Hello, Did you know Zoho Sign works right inside the Microsoft apps you already use? A signature request shouldn't mean leaving Teams for another tab, or downloading an Outlook attachment just to sign it. Zoho Sign integrates with Microsoft 365, Teams,
                                                                                                                        • Billing Status and WO Status Field Colors -

                                                                                                                          Hello Team, I noticed that the colors of the Billing Status and WO Status fields in the WO module have been changed. (Org ID:170000078905) This is not urgent to correct, but I wanted to bring it to your attention so you can check whether this is a system
                                                                                                                        • Introducing throw statements in Deluge

                                                                                                                          Hello everyone, We're introducing a powerful addition to Deluge that gives you more precise control over error handling in your scripts. Whether you're calling an external API, validating user input, or enforcing a business rule, there are moments when
                                                                                                                        • Zoho Notebook、実はこんなところから使えます

                                                                                                                          ユーザーの皆様、こんにちは。ゾーホージャパンの田村です。 前回に続き、今回もZoho Notebookをご紹介します。 関連情報 メモの保存場所、見直しませんか?― Zoho Notebookで始める情報管理 仕事中、「この内容、メモに残してあとで見返したいな」と思う瞬間はありませんか? 会議中の一言、お客様とのやり取り、CRMで見つけた気づき、 ほんの数秒で終わる内容だからこそ、「あとで書こう」と思って、そのまま忘れてしまうこともあります。 そこで今回は、PCやスマートフォンはもちろん、普段お使いのZoho製品からもすぐにアクセスできるノートアプリ「Zoho
                                                                                                                        • I have been looking for CVID to get segmate list where & how can fnd it?

                                                                                                                          I am trying to get segment details from the Zoho API. The API documentation says that the CVID is a mandatory parameter, but I cannot find the CVID in the "getmailinglists" API. Can you tell me where to find the CVID?
                                                                                                                        • How do I increase the email attachment size in Zoho CRM ?

                                                                                                                          It looks like I'm limited to 10MB when sending an attachment using the email widget on a record in Zoho CRM. Is there a way to increase the size? Or can I use some other tool? From what I'm reading online, I'm maxed out at 10MB. Any insight would be greatly
                                                                                                                        • Introducing Incentives for Zoho CRM: Build, automate, and track sales commissions

                                                                                                                          Dear Customers, We are here with an amazing news! We built a direct solution to help manage your commission provisioning activity in your business. From creating commission plans to issuing payouts, this application leverages your sales reps’ performance
                                                                                                                        • Subforms and automation

                                                                                                                          If a user updates a field how do we create an automation etc. We have a field for returned parts and i want to get an email when that field is ticked. How please as Zoho tells me no automation on subforms. The Reason- Why having waited for ever for FSM
                                                                                                                        • Cannot format "start date" field in Zoho Flow

                                                                                                                          I am trying to recreate a flow that connects Inventory package creation to Zoho projects (where a task is created in a defined project). I've been able to troubleshoot everything EXCEPT the date fields; specifically the "start date" - which is quite important
                                                                                                                        • Dynamic Signature - Record owner

                                                                                                                          Hi everyone, I’m using Zoho Writer merge templates from Zoho CRM and have two questions: Owner signature: How can I automatically insert the CRM record owner’s signature in the merged document? I’m not sure where this signature is stored or how to reference
                                                                                                                        • GETTING THERE THANKS

                                                                                                                          So we are still testing thanks to the great Zoho team for firstly getting pricelists working (essential) and writing some code to hide delivery and pickup options. Brilliant. So price lists are a definite mainly because of VAT. We run our Zoho books with
                                                                                                                        • Time Zone is incorrect

                                                                                                                          Time zone is not working properly...I've checked it twice. I'm eastern U.S. time it's currently 12:22 pm EST. CRM shows 3:22 pm EST.
                                                                                                                        • CRM wants to access other apps and services on this device (Documents area)

                                                                                                                          Did anyone else see this today? It only seemed to popup in the Documents area. Blocking it did not stop the ability to upload files there... Why is this coming up and what apps/services is it requesting in the background? Also, is it applicable elsewhere
                                                                                                                        • Custom module - change from autonumber to name

                                                                                                                          I fear I know the answer to this already, but thought I'd ask the question. I created a custom module and instead of having a name as being the primary field, I changed it to an auto-number. I didn't realise that all searches would only show this reference.
                                                                                                                        • Zoho Mail outgoing webhooks stopped delivering events to my domain from Aug 28 to Sep 1, 2026 — temporary suppression by destination domain/IP?

                                                                                                                          Dear Zoho Mail support team, I run an application that receives email notifications from several Zoho Mail accounts via outgoing webhooks (Settings → Developer Space → Outgoing Webhooks), with REST API polling as a backup. What happened: between August
                                                                                                                        • How can I populate dropdown data with information from another source or app?

                                                                                                                          I want to maintain a list of items in another app (say in excel or another database) and sync those as items in a drop down menu, instead of copy pasting to import. Is this kind of a feature available?
                                                                                                                        • Dynamic Field Folders in OneDrive

                                                                                                                          Hi, With the 2 options today we have either a Dynamic Parent Folder and lots of attachments all in that one folder with only the ability to set the file name (Which is also not incremented so if I upload 5 photos to one field they are all named the same
                                                                                                                        • Getting there -thanks

                                                                                                                          So we are still testing thanks to the great Zoho team for firstly getting pricelists working (essential) and writing some code to hide delivery and pickup options. Brilliant. So price lists are a definite mainly because of VAT. We run our Zoho books with
                                                                                                                        • I want to prefill CRM Account information using the GSTIN of the Customer

                                                                                                                          Currently i need to add account details manually in zoho crm and when it syncs in zoho books manual working needs to be done. Whereas in zoho books i can prefill the customer details using the GSTIN which is great feature. Can the same be enabled for
                                                                                                                        • Next Page