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





      • Recent Topics

      • CRM Address Field - States with Countries in brackets

        Hi, Could you please remove the country in brackets from the Global State List, or at least allow us to edit these entries? It looks like the brackets were added during the initial data population, perhaps by someone building the list in a spreadsheet
      • What's New in Zoho Inventory | July & August 2026

        Hello users, The July and August 2026 releases bring a range of new features and improvements across the product. From the Nigeria Edition and Super Admin enhancements to Sri Lanka IRD-compliant invoicing, Loyalty Program Management, and improvements
      • Forms data export bug

        The export csv with a password has changed for the worst. It is less secure by not allowing complex passwords. Just last week and the last year (at least) I was able to use a complex, secure password. Export CSV moreover doesn't even work if I use a simple
      • Fax and email questions

        Does Zoho offer faxing capability? If so, how to do it? And, why is has my email inbox stopped in 2019? There are no more emails since then. Also if I delete all of those emails, will they delete it from my gmail account (I'm linked to a gmail email address).
      • Create a single record from multiple images with ICR

        Hello all, Zia's Intelligent Character Recognition can now create a single record from multiple images. Users can upload up to three images at once, such as an ID, a passport, and a business card, and Zia will extract the relevant information from all
      • How to present an Analytic on a CRM dashboard and filter it on loginuser id

        How to present an Analytic on a CRM dashboard and filter it on loginuser id? I want to display an Analytics pivot table (as a widget) on a CRM dashboard and have the pivot filtered on the loginuser. I want additional user-filters available, such as date,
      • CNIL - Suivi de Pixel

        Bonjour à tous, À la suite de la nouvelle recommandation de la CNIL sur les pixels de suivi dans les e-mails, savez-vous si Zoho Campaigns permet : de conditionner le suivi des ouvertures au consentement de chaque contact ; de proposer un lien permettant
      • Convert MBOX to PST File Using Free Methods

        MBOX is a mailbox format that is used by various email clients and services, such as Thunderbird, Apple Mail, Eudora, and Google Takeout. Yet, in order to be able to open your MBOX emails in Microsoft Outlook, you have to convert them from MBOX to PST
      • Live connection to DS files in Zoho Creator / ChatGPT

        As an idea, we are using ChatGPT to build with Zoho Creator (outside of Zia), which is works brilliantly to assist write deluge, provide test suggesitons etc. Currently we are uploading the DS files which are very point in time, it would be great to have
      • Setting default From address when replying to request

        At the moment, if I want to reply to a request, the From field has three options, company@zohosupport.com, support@company.zohosupport.com, and support@company.com. The first two are really internal address that should never be seen by the customer and
      • Zoho Payroll: Product Updates - Q3, FY2026

        Over the past quarter, Zoho Payroll has added several updates to make payroll easier to process, configure, and manage. The most notable improvements cover bank integrations, reimbursement support, payslip enhancements, employee exit documentation, payroll
      • Convert OLM to PST on Mac and Windows Using Free Methods

        When your Outlook for Mac data is stored in an OLM file and you want to use it with Outlook for Windows, the simplest approach to transfer your emails and other mailbox information is to convert the OLM file to a PST file. OLM is primarily associated
      • Add Payment Information (like Bank details)

        I am using the Free plan of Zoho Books. I need to add the bank details/ UPI details on the invoice. How can I do that. I have added the details in the Bank Section.
      • Placeholders for Multi-Level Discount

        I am using custom templates for Invoices and all other modules. Since i have activated multi-level discount (an early-access feature from zoho) "discount at line-item and transaction level", I need placeholders for using them in my custom templates. With
      • Running Balance

        Please add automatically Running balance in ledger view. Taking lot of time, every time to add manually
      • Accounting on the Go Series-47: Effortless GSTIN Management- Auto Populate TaxPayer Details in Zoho Books Mobile App

        Hello everyone, Welcome back! Today, we're focusing on a feature specifically designed for our Indian users in the Zoho Books-Indian edition, particularly those who deal with GST compliance regularly. We understand the importance of accurate and efficient
      • URGENT: Stalled DC Migration >72 Hours - Records Locked [Ticket #: 167813877

        The DC migration was started on 1st October at 6 pm and we were informed migration period as 48 hours but even after more than 72 hours, the migration seems still in progress. We sent two emails to check the status but no responses. We need the migration
      • Zoho Webinar - Sharing System Audio (NOT AVAILABLE)

        Hi, We are having a serious problem with Zoho Webinar. In the webinars we run, we very often share the audio from a video we are streaming directly from YouTube or other applications. Until recently we were using Zoom, but as we use other Zoho applications
      • Cash Recipt

        You can not receive cash more than 10000 from one party in a day and two lakh in a year. In statement you can't differentiate cash or bank receipt. zoho does not support this
      • Need to set workflow or journey wait time (time delay) in minutes, not hours

        Minimum wait time for both Campaigns workflows and Marketing Automation journeys is one hour. I need one or the other to be set to several minutes (fraction of the hour). I tried to solve this by entering a fraction but the wait time data type is an integer
      • Concern Regarding Stock Validation in Inventory Management

        Hi Zoho Team, We would like to highlight a concern regarding stock validation in the inventory system. As per standard inventory management practices, if the stock level is zero, the system should not allow users to create a shipment, packing slip, or
      • Change from OST to PST on Windows 10/11 Using Free Method

        There is an advantage in converting OST files to PST format if you need to access your Outlook data on a different computer, want to keep a local copy, or are trying to recover items from an old Outlook profile. The good point is that users of Windows
      • Meet PageHealth by Zoho PageSense: a free way to find out what's holding your page back

        We all know the feeling. You've spent days tweaking headlines, moving buttons, and rewriting copy, and you're still not sure why visitors aren't sticking around. Revamping your website is hard, and figuring out what's actually getting in the way is even
      • Important: Whitelist new proxy outgoing IPs for IN, SA, and UAE data centers

        Hello everyone, We're expanding the pool of proxy outgoing IP addresses for our IN, SA, and UAE data centers by introducing new IPs alongside the existing ones. This helps ensure high availability, optimal load distribution, and redundancy for outgoing
      • Zoho Flow Custom Function Issue

        I have a use case where I will be needing to post data to a wordpress site. Specifically to a custom post type with a bunch of ACF fields. I have setup trigger event correctly for Tookan and can receive data from the webhook. In order to post the data
      • How to Open .mbox file in Gmail with Attachments?

        Gmail offer users to backup INBOX folder in .mbox file format via Google Takeout Feature. Howver there is no such option to Restore Gmail MBOX. Thus I would like to suggest you to choose an alternate approach i.e. MBOX to Gmail Wizard. This utility will open .mbox file in Gmail with attachments.  Steps to open MBOX file in Gmail are; Run MBOX to Gmail Wizard Click Add File and add .mbox file. Enter your Gmail login credentials. Click Convert button. Finished! This is how you can open MBOX file in
      • Custom Validation for On Duty

        Hi Team, We would like to have custom validation support for the On Duty form in the Attendance module. We need to apply some restrictions, such as: Limit the number of On Duty requests per month. Restrict On Duty requests on selected days. Allow employees
      • Integrating FaceBook Ads into MarketingHub

        I would like to track the clicks from a FB Ad campaign into my website via marketinghub.  I cannot currently add a MH form directly to my FB page, as I receive an error telling me I need at least 2000 subscribers on FB to be allows to do that (yikes!) What is the best way to set up MH so I can track which FB are converting well?  I know I can reach the FB reports directly, but these do not track conversions from the MH forms on my website. Best regards, Joe
      • Migration from GoDaddy to Zohomail

        Hi All, I am trying to migrate all the emails from Go Daddy to zohomail account using the migration tool. i tried with imap method, its not working. when i try it with pop method, then only the emails from the go daddy account inbox ( not other folders), is getting transferred, how can i transfer all the folders in the email account from go daddy to zoho. and also the emails which are coming from go daddy are like new unread emails ( is there any where i can differentiate from read and unread emails)
      • How do I migrate from Office 365 to Zoho Mail?

        Check out Advik Email Migration Wizard, this software is specially developed to move mailboxes from Office 365 to Zoho Webmail. In addition you can migrate from Gmail, Yahoo, Rediffmail and 80+ webmail servers to ZOHO MAIL. Isn't it amazing? This is an all in one email migration solution. Steps to export emails from Office 365 to Zoho Webmail are as follows; Run Advik Email Migration Tool in your system. Select Office 365 as source and enter its login credentials. Select mailbox folders and choose
      • How to Backup Zoho to PST?

        I'm looking for a simple way to backup Zoho Mail emails to PST format. I tried the IMAP method with Outlook, but it seems slow and complicated for large mailboxes. I need a solution that can: Export Zoho emails to PST Preserve attachments and folder hierarchy
      • Shopify connector – product cost ("Cost per item") not synced, so COGS/gross margin can't be calculated

        Hi Zoho Analytics team, I use the native Shopify connector in Zoho Analytics (cloud) to build reporting dashboards for Shopify stores. As far as I can tell, the connector does not sync product cost, so there's no way to calculate Cost of Goods Sold (COGS),
      • Zoho Sprints - Q3 Updates for 2026

        Another quarter, another set of productive features. This time our focus was mainly to simplify in-app navigations and control all your work related activities within Zoho Sprints. We delivered 7 major features and 9 enhancements, which include Zoho Sprints
      • Which Zoho CRM tasks would you want an AI assistant to handle?

        I’ve started delegating my Zoho CRM work to AI – and many tasks now take me half the time. It has been so useful that we’re now working to make it available to everyone. Instead of clicking through records and tabs, I simply describe what needs to be
      • The Social Wall: August 2024

        Hi everyone, We're thrilled to bring you the latest updates, features, and improvements to help you get the most out of Zoho Social. Let's see what was new for us at Social in August. Post documents on LinkedIn You can now reach a lot more people and
      • Free PST Password Recovery Tool

        Recoveryfix PST Password Recovery is a specialized standalone utility designed to instantly unlock encrypted Microsoft Outlook PST files . It provides an efficient way to recover, reset, or entirely remove passwords when access credentials are lost or
      • How can I add a Custom Field (or Customer_name) to a picklist?

        Our workflow is Shopify-->SO -->Picklist-->Package-->Shipment. We would like to have the Picklist template to include a custom field "Customer_Notes" (we have created this field already). This way we get alerted when a customer has notes on their account.
      • Cash Flow Statement : Direct Method

        I can not see how can I see the cash flow statement using direct method. AS 3 recommends two formats of cash flow statement. The indirect method is there on Zoho but there report in Direct method. How can I see that by Direct method.
      • ZeptoMail is now Zoho CPaaS!

        ZeptoMail has a new name and it’s expanding beyond email. With ZeptoMail, our focus was simple : help developers and businesses with reliable transactional emails. At the time, email handled a big part of those customer moments. But transactional communication
      • Button Display Conditions

        Hi Guys, Is it at all possible to have extra button conditions? Context: We have data in our deals module which has a custom button which converts the deal into contacts + set up relationships between them. At the end of the conversion we set a field
      • Next Page