About webhooks | Zoho Sprints Help

About webhooks

A webhook is a HTTP callback or push API that automatically sends real time notifications to third party applications. These notifications are sent when you perform a set of events.

 

Before you start, you need to know the following:
  1. To start using a webhook, you need to link your application with the third party tool using a HTTP URL. This URL will receive data when a set of events are triggered. When the action related to any of the events are triggered, the data is sent to the URL.
  2. Triggers are set of events that you choose to send notifications when there is an update.   

Defined set of webhook fields
  

Field Name

Purpose

Limitations

Mandatory fields

Webhook Name

Enter your webhook name

150 characters

This is a mandatory field

Description

Enter a description for your webhook

20000 characters

 

URL

 

1. Enter the REST API URL of your third party application.

 

2. It is the URL where the HTTP request is triggered when the events are executed.

 

200 characters

This is a mandatory field

Module

 

Webhooks are module specific in Zoho Sprints. You can create a webhook for each module.

 

 

This is a mandatory field

Trigger Events

 

1. Each module has its respective trigger events.

 

2. Select the trigger events based on the module you choose.

 

3. The URL is triggered when the events are executed.

 

 

This is a mandatory field

Method

Choose the API method for your event.

 

- POST

- PUT

- DELETE

- GET

 

This is a mandatory field

Entity Parameters

 

1. Parameters that are associated with a particular module (projectid, sprintid, etc.)

 

2. Append parameters either in the standard format (JSON, XML, etc. or name = value) or a user defined format.

 

25 parameters

 

Custom Parameters

 

1. These are general parameters that are not associated to a particular module.

 

2. Custom parameters are mainly used to send API keys, oAuth tokens, etc. that are used for triggering the webhook.

 

10 parameters

 

Header Parameters

 

You can also define header parameters in your HTTP request.

 

10 parameters

 

URL Preview

 

1. It is the preview of the webhook URL with all the appended parameters.

 

2. This URL is used to notify the third party application.

 

Read-only mode

 

 

 

  Feature behavior

  1. Your webhook URL should always commence with http:// or https:// or www.  
  2. You can create only 25 webhooks for each particular module.
  3. You can associate a webhook only for a particular module. Once associated, you cannot associate the webhook to a different module.
  4. You can view the details of your failed webhook calls and webhook logs only for the previous five days.
  5. Your URL will get suspended if the webhook fails for five consecutive attempts. You must reactivate it.

Error codes  

Zoho Sprints displays the following error codes when a webhook is not executed.

 

HTTP Status Error Code

Reason

400 Bad Request

Missing parameter

401 Unauthorized

Invalid oAuth token

402 Request Failed

Valid parameters but the request failed

404 Not Found

Request item doesn't exist

500, 502, 503, 504 Server Errors

There's a problem with the third party application

 

Example  

When a sprint is created in Zoho Sprints add that as a milestone in Zoho Projects.

Requirements

  1. Account in Zoho Projects.
  2. Permission to access the API.

 

Steps to follow

 

1. Create a portal in Zoho Projects
In Zoho Projects, create a portal and a project.  
 
2. Configure webhook in Zoho Sprints
  1. Enter values in the fields in the webhook creation form.
  2. Enter the webhook name. Here, we have named it as 'Milestone - Sprints'.
  3. In the URL, enter the third party application's URL. Here, Zoho Projects is the third party application.


  1. Your webhook URL should always commence with  https:// or http:// or www.
  1. Enter a description for the webhook URL.
3. Choose the module and trigger events
  1. The purpose of the webhook is when the user creates a sprint in Zoho Sprints it should be added as a milestone in Zoho Projects. Here, the action is using the 'Sprints' module.
  2. Select the module Sprint.
  3. Choose the trigger event as 'Sprint Added'.  You can also choose the other actions like Sprint Update, Sprint Delete, Sprint Start, Sprint Complete.
  4. Select the method as POST.   

4. Parameters in user defined format 


Info
Param Name:  sprintObject
Param Value:
{sprintName=${Sprint.SprintName},
sprintId= ${Sprint.SprintId},
sprintNumber = ${Sprint.SprintNumber}}
 
Custom Parameter (Name = Value)
apiKey = <api_key>
authToken = <auth_token>

5. Create a sprint and test your integration

Start testing your integration by adding a sample sprint in the project. This will trigger the webhook URL with the defined parameters and a sample milestone is added in Zoho Projects. 

      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 FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              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
                              Intake FormsLegalMobile App
                              Form DesignerHRMobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsEncrypted Forms

                              Secure 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


                                                              • Desk Community Learning Series


                                                              • Digest


                                                              • Functions


                                                              • Meetups


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner


                                                              • Word of the Day


                                                              • Ask the Experts


                                                                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

                                                                                                                        • Create and manage webhooks

                                                                                                                          Create webhooks and use them to automate notifications. Learn more. Create webhook To create webhook: Click the gear icon at the top-right. The settings window will appear. Select Webhooks under Automation. Click the +Webhook button. The creation ...
                                                                                                                        • 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 ...
                                                                                                                        • 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 ...
                                                                                                                        • Zoho Sprints GDPR Compliance

                                                                                                                          Data privacy and security are the core elements that every business should guarantee its customers with. Keeping this in mind, the European Union's General Data Protection Regulation (GDPR) came into discussion. It enforces all the businesses across ...
                                                                                                                        • 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 ...
                                                                                                                          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