Webhooks

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 professional 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

  1. Navigate to  in the upper-right corner.
  2. Select  Webhook from  Automation. 
  3. Click + Webhook.
  4. Enter the webhook details.
  5. 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.
  1. Navigate to   in the upper-right corner.
  2. Select  Webhooks under Automation.
  3. Click  Other Actions icon next to + Webhook.
  4. 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. 
  1. Navigate to  in the upper-right corner.
  2. Select  Webhooks in Automation.
  3. Click  Other Actions icon next to + Webhook.
  4. Select  Webhook Logs. 

Edit webhook 

You can modify your webhook details. 
  1. Navigate to  in the upper-right corner.
  2. Select  Webhooks under Automation. 
  3. Click  Edit icon next to the URL.
  4. Modify the changes in the URL.
  5. Click Save.


Delete webhook   

You can also delete the webhook anytime.
  1. Navigate to  in the upper-right corner.
  2. Select  Webhooks under Automation. 
  3. Click Delete icon next to the URL.
  4. 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. 

    • Related Articles

    • Webhooks

      Webhook is a developer-friendly module that facilitates 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 ...

    • Webhooks

      Webhooks facilitates communication with third-party applications by sending instant web notifications every time an event occurs in Zoho Recruit. With Webhooks, you can configure HTTP URLs and associate them in workflow rules to automate the entire ...

    • Webhooks

      Webhooks facilitates communication with third-party applications by sending instant web notifications every time an event occurs in Zoho Workerly. With Webhooks, you can configure HTTP URLs and associate them in workflow rules to automate the entire ...

    • Manage Webhooks

      Overview of webhooks Webhooks facilitate automated HTTP notifications. These notifications are triggered in third-party applications when a predefined action is performed by the user. Business Uses of Webhooks Webhooks can be used to collaborate with ...

    • How to create webhooks

      Webhooks is a feature that lets you collect real-time data or information from other applications and websites over the web. This feature is simple and easy to implement. The websites that you need information from are hooked to a URL which is setup ...