Webhooks
Webhooks facilitate automated HTTP notifications to third party applications from Zoho Projects. Using Webhooks, you can configure your own HTTP URLs and associate them to specific business rules in order to automate the entire notification process related to issues. To know more about Webhooks, please refer to WebHooks.org.
Configure Webhooks
- Click
in the top navigation panel.
- Navigate Issue Tracker > Webhooks.
- Click Add Webhook.
- In Webhooks page, specify all the necessary parameters.
- Click Save.
List of fields in Webhook configuration
| Field Name | Description | Data type | Constraint |
| Name | Specify the Webhook name. | Text | 100 characters |
| URL to notify | Specify the REST API URL of the third-party application. | URL | 1000 characters |
| Method | Select the type of API method - POST or GET. By default, the POST method is selected. | Radio button | - |
| Append issue parameters |
| Text | 3000 characters |
| Append custom parameters |
| Text | 3000 characters |
| Preview URL | Preview the complete webhook URL to notify the third-party application. | Read-only | Read-only |
Associate Webhooks to a Business Rule
- In Business Rules, navigate to Rule details -> Criteria -> Actions.
- In Actions, click Call Webhooks.
- Click
to create a new Webhook or click
to call an existing Webhook for the business rule.
- Click Save Rule.
Learn More about configuring business rules.
Test Webhook Integration
- Add test data in Zoho Projects according to your business rule criteria.
- In your application check for the update / data received from Zoho Projects via a webhook notification.
- If there is an error or data mismatch, modify your webhook settings in Zoho Projects.
- Continue testing until you get the desired results from Zoho Projects to your Application.
Known Limitations
- Only 10 Issue related parameters and 5 Custom parameters are allowed per Webhook.
- One issue related parameter in user defined format(xml, json..) is allowed.
- Sample issue related parameter in user defined format: <issue-data><title>${Issue.IssueTitle}</title><key>${Issue.IssueKey}</key></issue-data>
- Sample issue related parameter in user defined format: <issue-data><title>${Issue.IssueTitle}</title><key>${Issue.IssueKey}</key></issue-data>
- Webhook is triggered only through a business rule i.e. when a business rule is executed, the associated webhook is called.
- Only one webhook is associated to a business Rule whereas multiple business rules are mapped to the same webhook.
- Only 1000 webhook calls are allowed per day.
- A failed webhook execution is not retried.
- Webhook is deactivated when the webhook call fails continuously for 10 attempts.
- No mail notification is sent if the webhooks call threshold is reached for the day or if the webhook is disabled due to continuous failure.
- Webhook failures are audited and the Webhook Failures page displays only the last 100 failures.
Error Codes
When the execution of a Webhook fails, one of the following error messages is displayed in Zoho Projects:
HTTP Status Codes
- 400 Bad Request - Often missing a required parameter.
- 401 Unauthorized - No valid Auth Token.
- 402 Request Failed - Parameters were valid but request failed.
- 404 Not Found - The requested item doesn't exist.
- 500, 502, 503, 504 Server errors - Something went wrong on the third-party application.
- Error Code 1 - Temporarily unable to connect to the API server. You need to check API server logs and firewall settings for our requests sent from Zoho Projects.
Custom Errors
- Internal process failure - When the webhook is not executed due to errors while processing the webhook.
- Day limit reached - When the company reaches the maximum limit for the day.
Business Scenario
Send SMS alerts to Project Owners.
Purpose
When an issue is marked as a Show Stopper in your Issue Tracker, you can send an SMS with the issue title to the project owner by associating a webhook to a business rule.
Pre-requisite
- Account in SMS gateway service
- Permission to access Business Rules & Webhooks
Procedure
- Create an account in SMS gateway service
- Configure webhook in Zoho Issue Tracker
- Set up Business Rule
- Test your webhook integration
Step 1: Create an Account in SMS Gateway
In your SMS gateway service, create an account and get the following details to configure webhook:
- API URL
- Username
- Password
- API Id
Currently Zoho has partnered with the following SMS Gateway providers:
- Bulk SMS
- Clickatell
- Screen Magic
- Valueleaf
- Solutions Infini
You can buy SMS credits and API details from the above vendors.
Step 2: Configure Webhook
In the Webhooks page, specify the following details:
URL to notify:
- http://<IP Address>/smsgateway/post - POST method
Parameters in User Defined Format:
Param Name - Text
Param Value -
Hi ${Issue.ProjectOwner},
Following Issue is marked as ${Issue.Severity}.
${Issue.IssueKey} - ${Issue.IssueTitle}
Due on ${Issue.DueDate}
Custom Parameter (Name = Value):
user = <gateway_user_name>
password = <api_password>
api_id = <gateway_unique_api_id>
to = <user_mobile_number>
Step 3: Set up a Business Rule
Create a business rule with the following specifications:
- Business Rule Name - Show Stopper
- Execute on - Field Update - Severity
- Criteria : Severity is Showstopper and Status is not Closed
- Action :
- Reproducible - Always
- Assign to - Developer
- Call Webhook - Choose the webhook created in the previous step
- Reproducible - Always
- Save the business rule. Learn more about creating business rules.
Step 4: Test the Integration
Add a test issue in the project and assign it to a developer. Also, change the value of Severity to Show Stopper. This will trigger the webhook associated with the above rule and the project owner will receive an SMS alert with the Issue title, Severity, and Due date.
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 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.
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho TeamInbox Resources
Zoho DataPrep Resources
Design. Discuss. Deliver.
Related Articles
Webhooks for Tasks
Webhooks facilitate automated HTTP notifications to third party applications from Zoho Projects. Webhooks allow you to send real-time data from one application to another whenever an event occurs. Using Webhooks, you can configure your own HTTP URLs ...Webhooks for Projects
Webhooks enable users to send automated HTTP notifications to third-party applications. Webhooks transmit real-time data from one application to another when an event or trigger occurs. You can define your own HTTP URLs and associate them with ...Project Automation in Zoho Projects - Concept
Project automation in Zoho Projects simplifies project management by updating project fields automatically and connecting your projects with other applications. Users can set criteria, trigger an action and send automated notifications. Use case ...Bitbucket Integration
Having multiple lines of code and changing versions can be difficult to track. Commit codes in Bitbucket and view the changesets inside Zoho Projects. You can integrate Zoho BugTracker with Bitbucket using webhooks. You must be an Admin to integrate ...Task Automation in Zoho Projects - Concept
Task automation in Zoho Projects simplifies and accelerates project management by automating routine tasks, and connecting your projects with other applications. Use cases HR: A HR manager in a software company uses Zoho Projects to manage employee ...