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


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

                                                                                    Zoho Projects Resources


                                                                                      Zoho Sprints Resources


                                                                                        Qntrl Resources


                                                                                          Zoho Creator Resources



                                                                                              Zoho CRM Resources

                                                                                              • CRM Community Learning Series

                                                                                                CRM Community Learning Series


                                                                                              • Kaizen

                                                                                                Kaizen

                                                                                              • Functions

                                                                                                Functions

                                                                                              • Meetups

                                                                                                Meetups

                                                                                              • Kbase

                                                                                                Kbase

                                                                                              • Resources

                                                                                                Resources

                                                                                              • Digest

                                                                                                Digest

                                                                                              • CRM Marketplace

                                                                                                CRM Marketplace

                                                                                              • MVP Corner

                                                                                                MVP Corner









                                                                                                  Design. Discuss. Deliver.

                                                                                                  Create visually engaging stories with Zoho Show.

                                                                                                  Get Started Now


                                                                                                    Zoho Show Resources

                                                                                                      Zoho Writer

                                                                                                      Get Started. Write Away!

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

                                                                                                        Zoho CRM コンテンツ




                                                                                                          Nederlandse Hulpbronnen


                                                                                                              ご検討中の方





                                                                                                                        • Recent Topics

                                                                                                                        • Why can't we choose Fixed Asset account for Purchased Items? (eTims issue?)

                                                                                                                          Hello, When the company purchase items not for sale and not supposed to be in the inventory stock, like equipment for operational use, there is no way to access the Fixed Asset accounts in the drop down list. Is that an eTims limitation again? Or something
                                                                                                                        • "Track Inventory for this item" is forced checked by default for goods items (eTims issue?)

                                                                                                                          Hello, Since connecting our Zoho books to eTims (Kenya) the "Track Inventory for this item" is forced checked by default (eTims issue?) in the Item creation page for any type of goods. So when purchasing anything that the company does not intend to sale,
                                                                                                                        • Zoho CRM Functions: Redesigned Interface, Rich Analytics, and Multi-Language Support

                                                                                                                          Hello everyone! We have given Functions in Zoho CRM a major overhaul with a new interface that makes it easier to build, organize, monitor, and troubleshoot your functions throughout their lifecycle. As part of this revamp, we have also introduced a unified
                                                                                                                        • Can you import projects into Zoho Projects yet?

                                                                                                                          I see some very old posts asking about importing project records into Zoho Projects. But I can't find anything up to date about the topic. Has this functionality been added? Importing tasks is helpful. But we do have a project where importing projects
                                                                                                                        • reset password

                                                                                                                          Hi I need to reset my password and need help
                                                                                                                        • Is it possible to set a value to a field based on certain conditions

                                                                                                                          Greetings Say i have a field that i want to set its value based on the value of another field.. for example if "number" field has value greater than 10, i want to set my field's value to X. Or if radio group had option 1 selected, then i want to set my
                                                                                                                        • Native SMS and MMS Channel Support

                                                                                                                          89% of US consumers say they prefer to communicate with businesses via SMS / MMS (aka "texting"). (link) Unfortunately, Zoho Desk does not currently support the most popular channel for consumer communications in the United States. For those of us in
                                                                                                                        • Zoho CRM Layout Rules: Nine New Actions, Profile-Based Execution, and Interactive Preview

                                                                                                                          Hello everyone, Availability: This feature is now available for customers in the JP and SA DCs. It is planned to be released for other customers in soon. We’re excited to announce powerful new enhancements to Layout Rules in Zoho CRM - a feature built
                                                                                                                        • Global Sets for Multi-Select pick lists

                                                                                                                          When is this feature coming to Zoho CRM? It would be very useful now we have got used to having it for the normal pick lists.
                                                                                                                        • How to add line breaks in formula with Concat?

                                                                                                                          I am trying to combine different fields with a formula field, but want to add line breaks.  I.e. the current code looks like:  Concat(${Contacts.Company_Name}, ' ' ,${Contacts.First_Name}, ' ' ,${Contacts.Last_Name}) And the result should be:  John Doe
                                                                                                                        • Introducing spam detection for webforms: An additional layer of protection to keep your Zoho CRM clean and secure

                                                                                                                          Greetings all, One of the most highly anticipated feature launches—Spam Detection in webforms—has finally arrived! Webforms are a vital tool for record generation, but they're also vulnerable to submissions from unauthenticated or malicious sources, which
                                                                                                                        • Is Zoho Assist Secure Connect even practical for 1 person shop?

                                                                                                                          I was gun ho with Zoho Assist to replace my existing Remote Access product I have been using but I need to implement MFA on each unattended connection. Right now each of these connections in my other product has a rotating token that I have enter off
                                                                                                                        • Join the Zoho Desk Virtual Classroom Training (VCRT)

                                                                                                                          Hello everyone, Have you heard about Zoho's Virtual Classroom Training (VCRT)? Zoho Desk's Virtual Classroom Training offers end-to-end training for Zoho Desk users. Join the VCRT and get hands-on guidance for setting up Zoho Desk and getting your business
                                                                                                                        • Zoho CRM's revamped timeline view now extends to 3 years and support notes, filters, and email statuses

                                                                                                                          Editions: All DCs: All Release plan: These enhancements are being rolled out to customers in a phased manner. They will be available to most organizations by the end of May. For organizations with huge volumes of data, they will be available by the end
                                                                                                                        • Zoho Mail App Unable to connect to server

                                                                                                                          Hi all, For the last two weeks, my Zoho Mail App on my iPhone which has worked fine up to this point has been unable to connect to the mail server. I can't access my emails even though I will get notification banners on the screen saying that they have been received. I can open Safari on my phone and then log in that way. This issue happens when I'm connected to wifi and on my phone data.  I've tried deleting the app several times and reinstalling, and have updated to the latest version. But it still
                                                                                                                        • 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
                                                                                                                        • Add the Zoom Option to the Camera

                                                                                                                          Hi, I use the ZOHO Forms Camera so I can manage metadata, compression, etc. but this doesnt have the zoom parameter activated, so when we have photos in a tight space and want to use 0.5 for example, we can't, can this be enabled please. Thanks Dan
                                                                                                                        • Manage booking pages from your Android phone

                                                                                                                          Hello everyone! We are happy to announce that users can now add and manage booking pages from their Bigin Android app. It is a multi-step form that users can create for purposes like booking appointments, scheduling calls or meetings, conducting webinars,
                                                                                                                        • New UI - Color Preference Not Saving Permanently

                                                                                                                          Small, not very urgent problem I'd like to share regarding the new UI theme color. I've changed my theme preference to the default blue color around 20 times by now. It always reverts to a green color theme. I've followed the instructions of changing
                                                                                                                        • Automating Employee Birthday Notifications in Zoho Cliq

                                                                                                                          Have you ever missed a birthday and felt like the office Grinch? Fear not, the Cliq Developer Platform has got your back! With Zoho Cliq's Schedulers, you can be the office party-cipant who never forgets a single cake, balloon, or awkward rendition of
                                                                                                                        • Unbundle feature for composite items

                                                                                                                          We receive composite items from our vendors and sell them either individually or create other composite items out of them. So, there is a lot of bundling and unbundling involved with our composite items. Previously, this feature was supported in form
                                                                                                                        • Inventory Barcode Creation - Add Picture of Item

                                                                                                                          Hi I am trying to set up bar code labels and include a picture of the item on the label - any idea on how to add that field to the barcode generator?
                                                                                                                        • Gemini Action - Add "inineData" Support

                                                                                                                          Thank you guys for adding a Gemini action. I like Gemini models for the "grunt work" of AI, as they have the cheapest tokens of the trustworthy providers One thing that's missing in the action, though, is the ability to pass file data. If you pass a base64-encoded
                                                                                                                        • Protect backed up and exported data using password encryption

                                                                                                                          Hello everyone, Protecting live data is crucial for any organization or product, as it contains sensitive customer information. However, protecting data does not end within the platform. Backup and export files often contain sensitive information and
                                                                                                                        • Smarter holiday planning with yearly-specific Holiday Lists

                                                                                                                          Hello everyone! Managing holidays and business hours is now easier and more efficient. Holiday Lists now support holidays that fall on different dates every year, while business hours now supports more than one holiday list. This helps businesses manage
                                                                                                                        • Zoho Projects - Cloning a task does not trigger task workflow when created

                                                                                                                          Hello! I have a Project where my team uses a set of tasks from a tasklist as templates, so we could simply clone it and drag it to another list in kanban view to avoid creating a new one from scratch. The process works well, but after cloning it the new
                                                                                                                        • Best way to setup Inventory bin tracking for products with multiple boxes/crates

                                                                                                                          Hi - we need some advice from the community on setting up Items in the Inventory for products with multiple crates. We have large products in our warehouse where the product is delivered as two large (double pallet) crates. We've setup the Items for these
                                                                                                                        • Cliq iOS can't see shared screen

                                                                                                                          Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? Regards
                                                                                                                        • not able to access Zoho from home WIFI

                                                                                                                          for some reasone i am not able to access Zoho on my laptop or my iphone while i am connected to my home Wifi, i am able to access these sites both on laptop as well as Iphone and associated apps on any other Wifi as well as when I am on my 4G connection
                                                                                                                        • Five Guided Conversations Updates in Zoho Desk

                                                                                                                          Hello everyone, Guided Conversations is getting updates that make it easier to create more inclusive customer experiences, retain important conversation context, customize your widget, keep track of changes, and connect with external services. Here are
                                                                                                                        • zoho desk

                                                                                                                          Hello, Did Zoho Desk have any issues today? Are tickets coming in late? I have an email account linked, and messages seem to be arriving with a delay—some email threads aren't coming through completely, and so on.
                                                                                                                        • An important update for Zoho Cliq desktop users

                                                                                                                          The latest version of the Zoho Cliq desktop app (v1.8.0) will no longer be supported on macOS 10.15 Catalina and earlier versions. This is because the framework we use (Electron) no longer supports some older macOS versions. If you’re using macOS 10.15
                                                                                                                        • Simplify eSignatures: Automate document workflows with Zoho WorkDrive

                                                                                                                          Hello everyone, We’re excited to invite you to our upcoming live webinar, where Zoho WorkDrive and Zoho Sign will come together to show you how to simplify and automate document workflows. From creating and collaborating on documents to approvals, e-signatures,
                                                                                                                        • Function #7: Fetch a value from Deal in Zoho CRM to the related Estimate in Zoho Books

                                                                                                                          We're here with another function for those using the integration with Zoho CRM. You know that potentials can be linked to transactions in Zoho Books. But if you're including additional details about a Deal (potential) in Zoho CRM and you want to inherit
                                                                                                                        • Turn off workflow Applied pop-up

                                                                                                                          hi We are new to Desk. I have a rule to set to "waiting for customer" when agent sends reply. This comes up every time. How to i turn off? Or am i seeing as admin.
                                                                                                                        • Workflows being applied and the Large unwanted popup

                                                                                                                          When a workflow is being applied do to an action, then the Agent is left with a large Window asking if they would like the see the changes this workflow did. Is there any way to disable this prompt from appearing?
                                                                                                                        • Maintenance notice for Zoho CommunitySpaces US data centers on August 23, 2026

                                                                                                                          Dear customers, We have scheduled a maintenance activity for Zoho CommunitySpaces in our United States (US) data centers on August 23, 2026, from 1:30 a.m. to 2:00 a.m. During this 30-minute maintenance window, Zoho CommunitySpaces will be temporarily
                                                                                                                        • Knowledge base: The nitty-gritty of SEO tags

                                                                                                                          A well-optimized knowledge base with great SEO can benefit your company by allowing customers to find help articles and support resources using search engines. This enables customers to quickly and efficiently find the information they need without direct
                                                                                                                        • zoho desk: Can tickets be created from Microsoft Teams messages?

                                                                                                                          I am trying to see if there is a way to integrate Microsoft teams with zohodesk. we have a few customers who prefer to communicate requests through Teams, and it would be great to create tickets when they do.
                                                                                                                        • ´´Send Email Reply´´ action does not work when the message body contains placeholders.

                                                                                                                          Hi Community, I am working on a workflow where the Customer contact is notified via email when their ticket status goes On Hold. To do that, I chose the Send Email Reply action, and the minute I add a placeholder, the workflow does not work and the ticket´s
                                                                                                                        • Next Page