Storing and managing module-specific data in Zoho Sprints extensions

Storing and managing module-specific data in Zoho Sprints extensions

Storing and handling data related to Zoho Sprints modules is a key necessity when managing an extension. In this post, we'll look at the advantages of data storage and how it can be used with an example demonstration.

Data storage

An introduction

In general, storing data makes it easier to access it later when there is a need to perform the relevant functionalities. Zoho Sprints allows you to store, retrieve, edit, and delete module-specific data while handling widgets in an extension. You can check out details on data storage in this documentation.


The supported Zoho Sprints modules

Zoho Sprints currently supports data storage across these modules:
  1. Item - GET | SET | UPDATE | DELETE
  2. Sprint - GET | SET | UPDATE | DELETE
  3. Release - GET | SET | UPDATE | DELETE
  4. Meeting - GET | SET | UPDATE | DELETE
  5. Projects - GET | SET | UPDATE | DELETE
  6. Timesheet - GET | SET | UPDATE | DELETE
  7. Epic - GET | SET | UPDATE | DELETE
There are individual APIs to get, set, update, and delete module-specific data in Zoho Sprints. You can refer to the data storage APIs for each of these operations linked above.

Use case scenario

Consider the following scenario: a team member handles a feature request as a release in Zoho Sprints. Assume they completed the feature and finished the release, and they recorded a release note. Now, say a new enhancement request arrives for the same feature, and another team member is required to work on it. It would be best if the new member reviewed the previous release notes before commencing the feature enhancement.

In this case, a widget can be created to allow members to log their release notes, including the date and version. When a new member begins their enhancement work, they can refer to previously logged release notes and versions to proceed with their work. Once completed, they can log their own release notes accordingly.


Steps to implement this use case
  1. Create a connection
  2. Create an extension and configure its plugin-manifest.json file
  3. Create a widget to handle the data storage logic
Let's go over each of these processes in depth using an example.

1. Create a connection
  1. Go to Sigma and navigate to the Connections section in the left panel of your Sigma workspace.
  2. Choose Zoho Sprints as the service from the dropdown list, then select your Zoho Sprints organization.
  3. Create a default connection for Zoho Sprints to fetch release details, store data, and retrieve extension storage data, ensuring that the required API scopes specified in the documentation are correctly added. Refer to our previous post on connections for guidance.


2. Create an extension and configure a widget in 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 the extension, include the sample JSON code that was generated for the Zoho Sprints connections.
  4. Configure a widget by providing the name, the embedding location, and the URL path of the HTML file to be rendered. For our example, a widget with the following details has been created:
➤ name: Log Release Notes
➤ url: The location of the releasenotes.html file (inside app folder) that will render the user interface required for our widget. We'll be creating this widget in the next section of this post.
➤ location: The release right navigation bar
➤ logo: The location of a standard Zoho Sprints logo (logo.svg) that is by default available while creating the extension. You can include and use your customized logo as well.


3. Create a widget to handle data storage logic

Once the connection is created and configured in the plugin-manifest.json file of the newly created extension, the next step is to design the widget that renders the UI and handles the logic to log release notes.

releasenotes.html file - The code is added as an attachment to the post.
  1. In the above code snippet, the mandatory init method is invoked in order to use the other required JS SDK methods. Then, the method to get the current location details is invoked. For our example, this method returns the release details which include the extension ID, team ID, project ID, user ID, and release ID.
  2. Using the retrieved details, the Zoho Sprints API to get extension release data is invoked. This API checks if any data has been stored against the release. If yes, it returns a status code of 200; else, it returns 404, which means no data was discovered.
  3. If the code is 200, the widget's Previous Release Notes section displays any previously recorded release data. If it's 404, the end user is presented with the message "No prior release notes."
➤ In our example, when the end user (member) accesses the widget for the first time, no release data would have been logged, so it will return code 404 and display the message accordingly.
  1. Next, under the widget's section to add new release data (notes, date, and version), the user enters the current release notes and clicks the button Add release note. Here, the Zoho Sprints API to set extension release data is invoked. This method requires a "If-Match" header parameter with an ETag as its value.
➤ ETag is an identifier that's generated each time data is stored. When storing data for the first time, the "If-Match" parameter can be an empty string.
➤ When the method is invoked, the data entered by the end user, including the release notes, release data, and version, is saved, and an ETag value is returned.
  1. The next time the widget is opened, the get extension release data API is invoked again. This time, because data has been stored, code 200 will be returned, and the data and its related ETag will be fetched and displayed to the end user in the Previous Release Notes section.
  2. When saving the most recent data using the set extension release data API, the previous ETag will be given to the header. Once the new data is stored, a new ETag is generated, and the cycle continues.
This way, the end user is prompted every time with the previous logged release note, helping them check and log their own.

Testing the extension

Once the development is completed, you can test the extension using the Run option in the Sigma cloud editor.


In this post, we explored the concept of storing and retrieving the data stored in the release module. Using this, you can get, set, update, and delete data for the supported modules in Zoho Sprints using the data storage concept. We hope you found this post useful. Keep following this space for more updates. Stay tuned!


SEE ALSO






        • Recent Topics

        • 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

        • Add ZeptoMail to Zoho One

          Hi Zoho Team, I would like to request that ZeptoMail be added as a fully included application within Zoho One. Why this is important Zoho One is positioned as a unified business operating system that brings the applications an organization needs under

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

        • 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

        • Zoho Tables is now available in Zoho One!

          Hello Zoho One users, We’re excited to announce that Zoho Tables is now included as a part of Zoho One suite! As teams grow, managing projects, approvals, inventories, campaign trackers, and operational workflows across multiple spreadsheets become difficult.

        • 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

        • 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

        • #3 Making it look like my business

          Day 3: Meera had created her first invoice. The numbers were right, but something still felt unfinished. Her studio name was there, but the address did not look the way she wanted. Her logo was missing, and the invoice did not really feel like it came

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

        • Scan & Fill with double quote key/value pairs

          Hi, An old Ticket moved to a Topic/Idea: I love the idea of the new Scan & Fill as it nearly covers my previous request for a QR Scanner to read a multi-part QR Code. My QR Codes are hard-coded as below: {"key1":"value1","key2":"value2","key3":"value3"}

        • Increase the "Maximum Saved Entries per User" Options Limit

          Hi, You can create lots of saved entries, yet the Limit when you apply one is 25, we may often expect 32 to be in draft, and therefore want to enforce that, can we increase the limit of this field from 25 to 100 (As you can just turn it off and have more

        • HEIC File Type Viewer

          Hi, It would be nice to be able to click on the images in the All Entries/Reports Tables which are HEIC the same as JPG, PNG, etc. so they open in a viewer from Zoho or the Attachment Service, today HEIC requires you to download each image and open it

        • Map Dependency Upgrades in Zoho CRM

          Map Dependency Fields enhancements are now available across all DCs. Hello everyone, We’ve introduced a set of enhancements to Map Dependency Fields to make setup simpler, faster, and more intuitive. Map Dependency helps control how values appear across

        • 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

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

        • Zoho Forms Submission URL

          Hi Zoho, It would be great to have a URL which can take us to specific form entries. For example: https://forms.zoho.eu/ACCOUNTNAME/report/FORMNAME/records/UNIQUE-REF I currently have a use case where I want to use Zoho Flow to create a module entry in

        • Optional Parameter in Deluge Sendmail function to link email to record

          I love sendmail - it offers flexibility (and, with standalone functions, commonality with minimal maintenance) over the years the templates hadn't offered. I understand the templates have come a long way, but I still prefer sendmail most days. That said...

        • 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

        • 📣 And the Bigin Customer Award winners are...

          50+ entries. Customers from across the globe. So many great Bigin stories. And now, it's time to celebrate the people who stood out. We launched the Bigin Customer Awards to see how businesses are using Bigin in their own unique ways, and you did not

        • Report Configuration - Unable to select "File_Upload" under Supporting Document

          Good day everyone. I encounter this issue whereby i have difficulty to select "File_Upload" under Supporting Document when i configuring my report. Ps: I have create Supporting Document in Zoho creator form as subform and the add this "File Upload" inside

        • Zoho CRM Multi-select values not translated

          Hello! I have some issue with translate custom multi-select fields in zoho CRM in other language. I download export file, but it has all my custom fields and picklist values exept multi-select fields picklist values.  Please, help me to undestand, is

        • Go Multilingual with Instant Bot Auto-Translation

          Imagine you run a travel company with customers across different regions. Your website chatbot helps visitors discover travel packages, answers questions, and makes bookings. As your business expands into new markets, you want to offer the same experience

        • Create Flexible Layouts with Layout Rules

          In a project, when a work moves from planning to execution, the information teams need can change at every stage. A project can need one set of details, a phase can need another, and a custom process may require an entirely different set of information.

        • Zoho Sites after login page blank

          after i login to zoho sites, it stalls at a blank screen please help

        • Map My Client Locations for Zoho CRM Extension: Turn CRM Addresses Into Action

          Hello everyone, Your CRM knows who your customers are. Now, see where they are on the interactive map directly from Zoho CRM. Introducing Map My Client Locations for Zoho CRM, an extension built for businesses that rely on sales visits, field service,

        • Find the conversions hiding outside your funnel: User Journeys is now live in PageSense

          Hello Everyone, We are excited to announce that User Journeys is now live in Zoho PageSense. Here is what that means for you. Funnels are great for one thing. They tell you how the path you designed is performing. Homepage to product to cart to checkout,

        • Zoho CRM Error message #2 : Fixing [Invalid Credentials] and [Authentication Fail] while configuring IMAP

          Hi Everyone! As a part of our Zoho CRM Error messages series, we're going to focus on couple of error messages that you might encounter while configuring IMAP and ways to resolve them. These are: [Invalid Credentials] [Authentication Fail] The annoying

        • Zoho Community Digest - August 2026 | Part 4

          Hi everyone, and welcome back! We're closing out August with a strong final week, from Incentives for Zoho CRM bringing commission management inside the platform to Sequences in Bigin automating customer follow-ups end to end. There's also an IP allowlist

        • Next Page