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:
- Default connections: Zoho provides a default set of applications that you can simply select, provide some basic information for, and connect to.
- 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
- Go to Sigma and navigate to the Connections section in the left panel of your Sigma workspace.
- Choose Zoho Sprints as the service from the dropdown list, then select your Zoho Sprints organization.
- 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.
- Refer to the "How to create a connection" section for the first three steps to create a connection.
- Select the Default Services tab.
- Check for Zoho Projects in the service list by simply searching for it.
- 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.
- 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:
- Create connections
- Create an extension and configure the plugin-manifest file
- 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.
- Select Custom Services.
- Click the Create New Service option.
- 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.
➤ Enter the scopes of the Zoho Assist APIs required for your extension's functionality.
➤ Click Create Service.
- 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.
- Enter a connection name, toggle Yes or No to Use Credentials of Login User, select the scopes, and click Create and Connect.
- You'll be asked to authorize the connection and provide access to your data for the scopes included. Accept and proceed.
- The connection will be successfully created and a sample JSON will be automatically generated.
- 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
- Navigate to the Extensions section in the left panel of your Sigma workspace.
- Click the New Extension button and create a new extension. You can refer to this post for detailed guidance on creating a new extension.
- 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
- Create a file called createsession.html inside the app folder to render and handle the logic of your widget.
- 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.
- 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.
- Once you enter into the test environment, install the extension and authorize the connections.
- 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
Purchase Requisition in Zoho Books
I want to understand if Zoho Books is having the following workflow: PR ( Purchase Requisition ) >> PO ( Purchase order) >> GRN/SRN ( Goods/Services receipt note) >> Bill
Enhancement Request: Preserve Canceled Zoho Bookings Meetings in CRM
I recently worked with Zoho Support on ticket 170383788 regarding what happens in Zoho CRM when an appointment is canceled in Zoho Bookings. Support confirmed that the current behavior is intentional: when a Bookings appointment is canceled, the corresponding
Introducing the Markdown editor in Zoho Learn
Hello everyone, We're excited to announce the release of the Markdown editor in Zoho Learn. With Markdown editor, you can create and import articles as Markdown. You can write content using simple Markdown syntax and see how it looks with the built-in
When will Bigin's latest AI features be available in Europe?
Hi, As I previously raised this question in the post “Introducing Bigin's latest AI features, built for the way you work!”, but received no response, I am bringing it up again here. It has now been five months since the announcement, and these AI features
Function #50: Send Mass emails to your customers
Hello everyone, and welcome back to our series! We have reached a milestone of 50 Functions, which means that we have automated 50 different tasks in Zoho Books. Every Friday, we have shared a nifty function aimed at either automating a task or streamlining
Time tracking
Hi there We are looking for a simple, intuitive but powerful time track application. We bill our clients by the time we spend, and so need to link Clients<>Projects<>Tasks or Activities<> Time spent. Is there an app in Zoho we could use? Many thanks.. Morri
Staff Tracking in
Hi , I would like to see what activity my staff does over Zoho CRM and over Zoho Mail . I need to know which deals in CRM haven't been touched or had an activity on by a particular staff member . Basically need to establish what work.gets done by WFH
Zoho Projects connector with Zoho CRM (Related List module) features
Hi community, I use Zoho Projects connected to Zoho CRM, where we associate Projects with Deals, clients, etc.. I am looking to change/edit the fields that are available in the integration. Currently it shows Project Status, Project Completion, Milestones,
Report: avg time to visit each lead
We are on zoho one. our sales team visits leads using the ZohoCRM app. They track their hours using the zoho books timer. So the results in zoho books look like this: -total hours worked: 8 In ZohoCRM we have a custom date/time field in each lead record
Creating a Stop Start Timer for Custom Moduel
Hello, I am trying to track Maintenance of internal Assets through Zoho CRM (I have tried the FSM, Projects, Inventory apps nothing is working the way I need it to). I have it all built in the CRM where I have internal work orders where i can keep track
Logging time to a Sales Lead in CRM
Hi, Is there a way to log time against a Sales Lead / Deal in CRM before it is won and becomes a project? Our employees often do work for sales opportunities and need to log time against them at any point of the sales cycle, before it is won. Thanks, Atif
Hourly Billing in Zoho CRM Deals, Books, and Projects?
We bill on an hourly basis and need that time added into a client's invoice in Books. A client might have multiple deals open with us that we are working on, and billing separately, and thus need separate invoices for each. The functionality of Projects
Time taken on a task
I notice that you can record the length of a call, but not an event or a task. When a potential progresses from beginning to end it is just a series of tasks/calls/events in a process. I have most of it automated depending on the type of sale and triggered by updating the sales cycle field. It follows that you should be able monitor the time of each of them so that you actually know how much time you spend on each potential. This gives an idea of profitability of each potential. I would think this
Timesheets from Deals
Hi Guys, new Zoho One customer here with only a few employees. I run a small software company and currently our small number of employees are creating manual timesheets in excel. There is a column for a job number (that relates to a Zoho Deal) and they just put in the time taken to perform the work. As an example, they might spend 1 hour running some barcodes for a particular client (and deal). Then they may do a support all for another client and that takes 2 hours (This client would have a yearly
Timesheet option in zoho crm
Recording a timesheet against a job is very crucial for every business because it will help them in billing the client accordingly and also it keeps a track on how much time a user is exactly taking in marking the job as cloed. Currently in crm there
Portal access is now available in the Zoho CRM mobile app
Hello everyone, Zoho CRM Portals provide a secure space for sharing selected records with people outside your organization. These portal users can include customers, vendors, partners, or anyone who needs access to specific CRM data. Previously, portal
Field of Lookup - 5 Field Association Limit.
This query relates to the post at: https://help.zoho.com/portal/en/community/topic/introducing-the-field-of-lookup-in-crm-public-early-access-2023 My simple (and common) scenario: I select an account / customer lookup and want their address pulled into
Zoho Forms API
Is there any way to get all form entry list using API? Looking forward to hear from you
Multiple locations
I have many customers (accounts) that have multiple locations, like bank branches. How can I manage them under one account?
Calendar won't load
I run into this problem about once a week, where I try to open my Zoho calendar in a web browser, and it just gets stuck, waiting forever to load (see attached screenshot). I'm usually using Edge or Duck-Duck-Go browser. Sometimes it loads just fine,
Feature Request: Enhance Zoho Books Customer Approvals with WhatsApp, Multiple Approvers, Automated Reminders, and Workflow Automation
Product: Zoho Books Module: Time Tracking → Customer Approvals Category: Feature Enhancement / Workflow Automation / Omnichannel Communication Description I would like to suggest several improvements to the Customer Approvals module in Zoho Books, particularly
Feature Request: Extend Zoho Books Customer Approvals API and MCP Support
Product: Zoho Books Category: API Enhancement / OAuth Scopes / MCP Integration Feature: Customer Approvals (Timesheet Approvals) Description I would like to suggest an enhancement to the integration and automation capabilities of Zoho Books, specifically
Introducing PRM: Build, manage, and scale your partner ecosystem
Growing a partner ecosystem is a good problem to have. What starts as a handful of partners can quickly turn into a maze of spreadsheets, emails, and disconnected processes. More partners mean more opportunities, greater reach, and new ways to grow
Tip: #14 Save words and phrases in Writer for faster writing!
As you start working with more documents everyday, you'd find yourself using certain words and phrases across documents quite often. In this week's tip, let's discuss two easy ways to train Writer to remember your commonly used words—equipping you to
Zoho ERP | Product updates | October 2026
Hello users, A new month, a fresh set of updates in Zoho ERP. This month brings Netting, enhancements across our verticals, and more updates to help streamline your everyday work. Explore this month’s updates and see what’s new. Compliance with Revised
Zoho Forms - Feature Request - Embed iFrame or Dynaic URLs in Description fields
Hi Zoho Forms team, I'm working with a client who uses Zoho Forms internally to collect information over the phone from potential work placement candidates. At the end of the form, the candidate needs to be booked in for an induction, which we've configured
BANK FEED - MAYBANK , provider from YODLEE IS NOT WORKING
As per topic, the provider YODLEE is not working for the BANK FEED. It have been reported since 2023 Q3, and second report on 2023 Q4. now almost end of 2024 Q1, and coming to 2024 Q2. Malaysia Bank Maybank is NOT working. can anyone check on this issue?
Digest Octobre - Un résumé de ce qui s'est passé le mois dernier sur Community
Bonjour chers utilisateurs, Bienvenue dans ce nouveau digest de la communauté Zoho France ! Vous y trouverez les discussions marquantes, les nouveautés produits, les conseils pratiques partagés et bien sûr les événements à venir. Le mois dernier, nous
Bank feeds - still a problem
I'm really frustrated that the bank feeds only "sometimes" work. I raised this problem once before and was advised that Zoho used Yodlee and feeds were only updated once a day. That's fine but it only "sometimes" seems to work. Eventually transactions appear but they sometimes seem to take days. I know of other programs (Xero) that another business I am involved with uses Yodlee and they do not have this issue. My bank feeds are active, I tried to manually refresh however Zoho tells me that
this is getting ridiculous
My checking account bank feeds haven't worked since 6/4/21. Multiple emails to Zoho since 6/10, and all they tell me is they have re-escalated my problem to their banking service provider team. 14 days and nothing is fixed. I'm just about ready to bail
No feedback from Zoho Books regarding Yodlee feeds for Investec
I reported on 6 Feb 2025 that the Bank Feeds for Investec bank via Yodlee are not working. To date there has been no resolution. You are charging us for a suite of products where the functionality does not work. Please advise how you will refund me for
ongoing bank sync problems
My bank feed broke May 14th 2021 Since then I just get an endless stream of we are working on it, "Kindly bear with us for sometime" from support Multiple times I have asked to speak to managers and half the time they don't call at all. If they do call
We must admit - Yodlee is an unreliable partner!
Hello Zoho, Our Yes Bank account intergration is messed up since the beginning and the problem has not been addressed yet. With bad synchronization, poor categorization of transactions, duplicate/unknown copies of accounts, no support, geared at income/expenses,
Make your PDFs clearer with shapes
Sometimes the best way to mark up a PDF is to point at it directly. Zoho PDF Editor includes shape tools that let you add circle, check and cross marks anywhere in your PDF, so you can flag content for review without extra comments. Here's what you can
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
Project Migration
We currently have two separate Zoho organizations: A Spark Robotic organization under Zoho CRM Plus A separate Contract Manufacturing organization under Zoho One We are working with Zoho Support to consolidate the CRM Plus organization into our existing
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
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
Improved Filtering and Tagging options for Notes
We rely on the notes section across several modules and would love to have some more options in filtering, grouping, and tagging notes. We would like to be able to filter notes differently on a contact or deal and have that choice stay on that record
Action required: Update the Zoho Desk Client SDK URL in your extensions
Hi Developers, To improve reliability and performance, the Zoho Desk Client SDK is now served from a new CDN domain. We request that you update your existing extensions with the new Client SDK URL given below. Note: Going forward, all newly created extensions
Next Page