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.
You can access webhooks only if you are on the premier plan.
What should a user do when they want to work on webhooks?
First, the user should link their application with the third party tool using a HTTP URL. This URL will receive a 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.
What are triggers?
Triggers are set of events that you choose to send notifications when there is an update.
Create a webhook
- Navigate to
in the upper-right corner.
- Select Webhook from Automation.
- Click + Webhook.
- Enter the webhook details.
- Click Save.
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 |
View webhook URL
You can view all the executed webhook URL's.
- Track the URL, it's trigger events, method, and status of the webhook URL.
Failed Webhook Calls
You can view all the recently failed webhook URLs here. You can update the webhook details.
- Navigate to
- Select Webhooks under Automation.
- Click Other Actions icon next to + Webhook.
- Select Webhook Failures.
When does a webhook get failed?
- When there is a misconfiguration of URL or parameters.
- When the server is not reachable to push the webhook details.
Webhook Logs
All the executed webhook URL's are logged and you can view them anytime.
- Navigate to
- Select Webhooks in Automation.
- Click Other Actions icon next to + Webhook.
- Select Webhook Logs.
Edit webhook
You can modify your webhook details.
- Navigate to
- Select Webhooks under Automation.
- Click Edit icon next to the URL.
- Modify the changes in the URL.
- Click Save.
Delete webhook
You can also delete the webhook anytime.
- Navigate to
- Select Webhooks under Automation.
- Click Delete icon next to the URL.
- Select Yes, Delete.
Notifications will not be triggered once the webhook is deleted.
Webhook limitations
- Your webhook URL should always commence with http:// or https:// or www.
- You can create only 25 webhooks for each particular module.
- You can associate a webhook only for a particular module. Once associated you cannot reassociate the webhook to a different module.
- You can view the details of your failed webhook calls and webhook logs only for the previous five days.
- We will suspend your URL 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 |
Business scenario
When a sprint is created in Zoho Sprints add that as a milestone in Zoho Projects.
Requirements
- Account in Zoho Projects.
- 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
- Fill up the following fields in the webhook form.
- Enter the webhook name. Here, we have named it as 'Milestone - Sprints'.
In the URL, enter the third party application's URL. Here, Zoho Projects is the third party application.
- Your webhook URL should always commence with https:// or http:// or www.
- Enter a description for the webhook URL.
3. Choose the module and trigger events
- 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.
- Select the module Sprint .
- Choose the trigger event as 'Sprint Added'. You can also choose the other actions like Sprint Update, Sprint Delete, Sprint Start, Sprint Complete .
- Select the method as POST.
4. Parameters in user defined format
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.
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 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 Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
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.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Import your data from JIRA to Zoho Sprints
As a first step, you will have to configure your JIRA account with your team in Zoho Sprints to which the data has to be imported. A few key points to know before you start to import Only a Team Owner or Admin can carry out the configuration. If you ...Zoho Cliq Extension
In a rapid work culture, there is rarely enough time to discuss things thoroughly. Communication is a key element in any workspace. Your team members are looking for the quickest way to get instant notifications on project updates chatting with their ...Completed sprints
This is a consolidated report of completed sprints. This report displays the sprint name, start date, actual and planned end dates, and completed estimation points. It includes an archived view of all the completed sprints in your project, displayed ...Canceled sprints
You can cancel the sprints that cannot be completed within the scheduled end date. How to cancel a sprint? You can cancel only the active sprints on your board. Navigate to Scrum Board . Select the sprint and click View Details . Click at the top ...Install Zoho Sprints for iPhone
Zoho Sprints is now available on your mobile. Install the Zoho Sprints app from your iPhone and manage your work on the go. Requirements: iOS - 13 and above Install Zoho Sprints to your iPhone You can either install it from your App Store or iTunes. ...
New to Zoho LandingPage?
Zoho LandingPage Resources