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



    Nederlandse Hulpbronnen


      • Recent Topics

      • 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

      • Images Not Displaying Properly in Zoho Desk

        Hi, We are experiencing an issue with image rendering in Zoho Desk, affecting both incoming and outgoing emails. Images embedded in email conversations are not displaying properly. Instead, we see broken image icons or empty placeholders where the images

      • 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

      • Export Exchange Online Archive Mailboxes to PST for Microsft 365 Users

        With Microsoft 365 it is possible to archive older emails in Exchange Online in order to keep the main mailbox tidy. If however you need to export the archived emails to a PST file for the purposes of backup, migration, compliance or for use offline,

      • Lookups and Custom Modules

        I created a Custom Module that I'm calling "Item Purchasing Group". This module will store information for groups of Items that must be purchased together (including minimum overall quantities and/or values, etc.). This will have a one-to-many relationship

      • Task Module quick create settings

        Hello, requesting the Task module receive a quick create customization settings. We have added custom fields and have to select "More fields" at the bottom of the pop-up to access the custom fields.

      • Your employees changed departments. Did your IT systems notice?

        An employee joins your Marketing team. HR adds their details to the organization's user directory. The IT admin, in turn, creates their Zoho One account, assigns the required applications, adds them to groups and provides access based on the organization's

      • AI Calling

        Hi, does anyone have experience or any thoughts on AI Calling. Getting AI to make calls on behalf of your company. We are looking into it, but are finding it difficult to get info and providers that can assist.

      • Zoho Books | Product updates | August 2026

        Hello users, July has been an exciting month for Zoho Books! This month, we're excited to introduce HTML PDF Templates, Placeholders as Pills, expanded approval workflows for Sales Returns and Journals, and significant compliance updates across the India,

      • Button or Links order

        Is there a way to re-order the buttons or links that are created? Moderation Update: With our recent enhancement to custom button creation from the layout editor, administrators can now reorder custom buttons directly from the layout editor, and this

      • Email Forwarding to Zoho Desk Failing After Migration from Gmail to Outlook (Microsoft)

        We recently migrated from Gmail to Microsoft Outlook. Since the migration date, emails sent by our customers are no longer being received by Zoho Desk. I tried setting up the email forwarding rules in Outlook similar to what we had in Gmail, but it still

      • Option to Disable Knowledge Base Section in Feedback Widget Popup Hello Zoho Desk Team

        Hello Zoho Desk Team, How are you? We are actively using Zoho Desk and would like to make more use of the Feedback Widget. One of the ways we implement it is through the popup option. At the moment, the popup always displays the Knowledge Base section,

      • How to Fix an Outlook OST File That Cannot Be Opened

        Have you at any time attempted to open Outlook only to find that your OST file cannot be accessed? It can be very annoying, particularly since the file holds important emails, attachments, and other mailbox data. This problem might arise due to file corruption,

      • Record positive and negative bank transactions in the same expense account

        Hello, I hosted a promotional event and paid a vendor $600 for food catering (bento boxes). Twenty people attended the event, and each person paid $30 for a bento box, resulting in 20 separate $30 transactions deposited into the bank. I coded the $600

      • Widget Height were destroyed

        All widget heights in the Details Canvas view are broken. Moderation Update: This is a known issue with widget heights in Client Script popups and flyouts. A fix is in progress, and this post will be updated once it's released.

      • Address limits per customer by edition

        I’m on the Standard edition and have reached a limit of 30 addresses under a single customer. Before I move to an annual Professional subscription, I need to confirm the following: What is the maximum number of addresses allowed under one contact, and

      • Is it possible to log text messages from iphone into Zoho CRM

        My team is more and more utilizing text messaging to communicate with clients. Does Zoho have a solution for logging these text messages when clicking "Send Text Message" from the Zoho app. Much like when you call, you get prompted to log a call, can

      • 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

      • 👍 Zoho CRM's Notes now gets Reactions and a new look

        Available in SA and JP DCs. Rolling out to other DCs in phases. Hello everyone, Notes help users capture important updates, collaborate with teammates, and maintain context for records. Now with Note Reactions, users can quickly acknowledge updates, express

      • How can I show an uploaded image larger/full size in a Zoho Forms response PDF?

        Hi,  I noticed that in a response PDF for Forms, the uploaded image is shown in a tiny box as seen in my screenshot. Is there any way I can make that appear larger in the response PDF? thanks.

      • Convert MSG to PDF in Bulk with Attachment Free

        Microsoft Outlook saves each email as an MSG file, keeping with it key information like the sender, the recipient, the subject, the date, the body of the message, and any attachments. It can, however, be quite difficult to access a large number of MSG

      • Zoho Tables is now part of Zoho One!

        Hey everyone! We've got some exciting news to share. Zoho Tables is now included in your Zoho One subscription at no extra cost. If you're already on Zoho One, head to your app list, add Zoho Tables, and get started right away. You don't need a separate

      • How to mass find and delete duplicate files from OneDrive

        It is easy to save documents, photos, videos, and all other types of files using Onedrive, but if you upload the same files more than once then your OneDrive storage can end up being filled with a large number of duplicate files. Manually searching out

      • Different Report sharing filters within same Dashboard

        I have a question about sharing filters for a dashboard which contains separate reports built from the same query. Below are the pieces of the puzzle: - “Sales Query”: line-level query containing sales for a team of 5 sales reps; there’s no need for the

      • Specifying time increments on a Date/Time field

        Hi all, Im using a Date/Time field in my CRM module. At the moment the increments are 30 minutes. How can I change these to be 15 minutes? Thanks

      • not able to convert pdf to jpg and other forms and vice versa.

        i want to change my pdf to jpg, word, etc and some times jpg to pdf. i don't know how to do in this.

      • Make Your Workflows Smarter with Zia Agents

        Hello, Enterprise Support Community, Workflow rules can now go beyond predefined actions. Zia Agents can now be invoked directly from workflow rules in Zoho CRM, allowing you to bring contextual, AI powered actions into your automated processes. Choose

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

      • DYK 14: Create Tasks with AI

        Did you know AI can suggest tasks within your Zoho Projects portal? Breaking a project into clear, actionable work items takes time and manual effort. Especially when the same team handles both planning and execution. AI task suggestions in Zoho Projects

      • #11 Nithya's First Overseas Client

        Nithya designs for clients in three countries and has never met any of them. Her first overseas invoice took a full evening. The second took four minutes. The difference was not a clever tax trick. She stopped treating every international customer as

      • Other languages in Schedulers (Zoho Books)

        Hello everyone, currently we have create functions in other languages, like nodejs etc but on schedulers we can use only deluge.. Are other languages on schedulers roll out? Kind regards, Sakis Oikonomou

      • New in Office Integrator: Extract data from images into your spreadsheet

        Hi users, We are pleased to introduce the Data from Picture feature in Zoho Office Integrator's spreadsheet editor. It intelligently detects and organizes text and numbers from any image into structured cells using OCR. With this feature, users can turn

      • Edit PDFs using Zoho PDF Editor

        Hello users, In a previous article, we covered the organizing capabilities of Zoho PDF Editor. Here, we'll provide a quick recap of its editing features, including a few new additions. A few highlights of Zoho PDF Editor's editing capabilities: Add and

      • Announcing the new SKILL.md for Zoho CRM and the updated OAS repository!

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

      • Partner with HDFC And Sbi Bank.

        Hdfc and sbi both are very popular bank if zoho books become partner with this banks then many of the zoho books users will benefit premium features of partnered banks.

      • Solution to Import OST File into Office 365.

        In today’s digital workplace, organizations are rapidly moving toward cloud-based email systems for better flexibility, security, and collaboration. Microsoft 365 has become one of the most widely used platforms for business communication. A common requirement

      • Multiple subscription plan line items in Zoho Billing quotes

        I run an IT company and sell a lot of licences. A client might have multiple subscription plans including software licences in different categories. A client might have Microsoft licences, antivirus licences, web hosting and maintenance package services.

      • Mail Merge templates in Sandbox

        Rolled out for all DCs Hello everyone, You can now create and test Mail Merge templates directly in Sandbox, making it easier to validate document generation without affecting your live organization. Why this matters Mail Merge templates are often used

      • 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

      • Zoho Books | Product updates | October 2026

        Hello users, October brings a range of new features and enhancements to Zoho Books, designed to simplify compliance, streamline accounting workflows, and improve inventory management. From the launch of the Nigeria Edition and France’s e-invoicing capabilities

      • Next Page