Execute standalone functions | Zoho Sprints Help

Execute standalone functions

Use standalone functions to process data that are operated by external parameters. Zoho Sprints provides the ability to create functions and use REST APIs to execute them to arrive at simple business solutions. These functions can be triggered from third party services or the web.

Standalone functions can be executed in two ways: Creating schedule to execute the functions or using APIs to execute them.

Scenario 1: Execute via schedule

Info
Let's assume as an admin user you need to notify users of overdue work items. To meet this requirement, you can create a standalone function to send weekly email reminders with an attached file containing the list of overdue items. You can create a recurring weekly schedule for the function to be executed periodically. With a one-time scripting effort, you could automate a critical business process.

Scenario 2: Execute via API

Info
Let's assume you are trying to invoke a function from Zoho CRM. When you are adding a new lead to your CRM, you want to create a corresponding work item in Zoho Sprints. To achieve this, you need to pass the Item fields as custom parameters.

Create standalone function

To create a standalone function:
  1. Click the gear icon at the top-right. The settings window will appear.
  2. Select Custom Functions under Automation.
  3. Click the dropdown on the Function button.
  4. Select the Function. The Create Custom Functions window will appear.
  5. Enter Display Name.
  6. Enter Function Name.
    Note: According to the general naming convention, function name cannot contain spaces.
  7. Select Category as Standalone.
  8. Select the Recurrence Type to determine the frequency at which the function needs to be executed.
  9. Enter schedule specifications based on the recurrence type.
  10. Provide a Description of the function.
  11. Script the function using the Deluge script builder.
  12. Click Save to complete creating the function or click Save and Execute to complete creating the function and execute it.
 

Execute function using API

APIs enable you to execute a function remotely using the function's unique ID.

Info
https://sprintsapi.zoho.com/zsapi/team/{teamId}/customfunction/{functionId}/execute/?arguments={"parameters":{"key1":"value1","key2":"value2", ....upto 25 parameters }}

Access parameter

You can pass custom parameters in standalone functions. Parameter refers to the value that is passed in the function. Passing this value in the function enables you to get the required response or output. The format for the parameter is that of key value pairs.

Info
To access param "key1" in deluge, enter value = sprintsAPIRequestMap.toMap().get("params").toMap().get("key1");
 
Notes
Note:
  1. You can customize the status code and send custom headers in your request.
  2. You can enter up to 25 parameters.
 

Define response object

Define the format in which the response of the API needs to be. The default response format in functions is JSON when the return is null. However, Sprints standalone functions support other formats like XML, HTML and Plain Text where you need to map object. The response format data has to be given to “sprintsAPIResponse" key in a map if you wish to format default response format 

      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          Zoho CRM Training Programs

          Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

          Zoho CRM Training
            Redefine the way you work
            with Zoho Workplace

              Zoho DataPrep Personalized Demo

              If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

              Zoho CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsRetailOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceForms for Solopreneurs
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit
                              Forms for Government
                              Intake FormsLegal
                              Mobile App
                              Form DesignerHR
                              Mobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic FormsInsurance
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsWufoo alternativeEncrypted Forms
                              Accessible FormsTypeform alternativeSecure Forms

                              WCAG

                                          Create. Review. Publish.

                                          Write, edit, collaborate on, and publish documents to different content management platforms.

                                          Get Started Now






                                                            You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                                Manage your brands on social media

                                                                  Use cases

                                                                  Make the most of Zoho Desk with the use cases.

                                                                   
                                                                    

                                                                  eBooks

                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho Desk.

                                                                   
                                                                    

                                                                  Videos

                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho Desk.

                                                                   
                                                                    

                                                                  Webinar

                                                                  Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                                   
                                                                    
                                                                  • Desk Community Learning Series


                                                                  • Meetups


                                                                  • Ask the Experts


                                                                  • Kbase


                                                                  • Resources


                                                                  • Glossary


                                                                  • Desk Marketplace


                                                                  • MVP Corner



                                                                    Zoho Sheet Resources

                                                                     

                                                                        Zoho Forms Resources


                                                                          Secure your business
                                                                          communication with Zoho Mail


                                                                          Mail on the move with
                                                                          Zoho Mail mobile application

                                                                            Stay on top of your schedule
                                                                            at all times


                                                                            Carry your calendar with you
                                                                            Anytime, anywhere




                                                                                  Zoho Sign Resources

                                                                                    Sign, Paperless!

                                                                                    Sign and send business documents on the go!

                                                                                    Get Started Now




                                                                                            Zoho TeamInbox Resources





                                                                                                      Zoho DataPrep Demo

                                                                                                      Get a personalized demo or POC

                                                                                                      REGISTER NOW


                                                                                                        Design. Discuss. Deliver.

                                                                                                        Create visually engaging stories with Zoho Show.

                                                                                                        Get Started Now









                                                                                                                            • Related Articles

                                                                                                                            • About custom functions

                                                                                                                              Zoho Sprints comes with the capability for you to create custom functions and automate your business process. A Custom Function is composed of a group of deluge statements that are combined to perform a certain task. This function can be invoked ...
                                                                                                                            • Manage custom functions

                                                                                                                              You can perform the following actions for functions: Create function Edit function Delete function Create function from gallery Create function To create custom function: Click the gear icon at the top-right. The settings window will appear. Select ...
                                                                                                                            • Merge and store documents using Zoho Writer

                                                                                                                              You can now use template functions to merge and store documents using Zoho Writer. The document template is built using the fields being merged from Zoho Sprints. The in-built deluge functions deliver the values to the merge fields in the document, ...
                                                                                                                            • Zoho Sprints Quickstart Guide

                                                                                                                              Zoho Sprints is a project management tool that functions on the principles of Agile Scrum methodology. Here, each project is divided into multiple phases. Each phase comprises select work items for the team to complete. When those work items are ...
                                                                                                                            • Zoho Sprints Extension for Google Marketplace

                                                                                                                              Zoho Sprints extension provides a simple solution to manage your work items from your Gmail inbox. Convert your emails into work items with the help of this widget. You can view and edit the contents of the item right there or quickly navigate to ...
                                                                                                                              Wherever you are is as good as
                                                                                                                              your workplace

                                                                                                                                Resources

                                                                                                                                Videos

                                                                                                                                Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                                eBooks

                                                                                                                                Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                                Webinars

                                                                                                                                Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                                CRM Tips

                                                                                                                                Make the most of Zoho CRM with these useful tips.



                                                                                                                                  Zoho Show Resources