Manage Webhooks

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

  1. Webhooks can be used to collaborate with a third-party SMS vendors to send SMS alerts to users linked to a job, such as job owners or assignees.
  2. You can also connect with your organization's logistics application to notify the delivery of orders when associated jobs are completed. 

Webhooks can also be used in blueprint transitions and business rules.

Add webhook

  1. Navigate to    and select Developer from the left panel.
  2. Navigate to Webhooks and click Add Webhook button.
  3. Enter the details. Refer the below section to know the specification of each field. 
  4. Click Save.



List of fields in webhook configuration

Field Name
Description
Data Type
Limit
Name

Specify the webhook name.
Text
3-50 characters
URL to notify

Specify the API URL of a third-party or Zoho application.

URL
265 characters
Method

Select the API method type: POST or GET. By default, the POST method is selected.

Radio button
-
Parameters in standard format (JSON, XML, etc.)

1. Enter the parameter name and select a value to insert as description.
2. These request parameters are used when triggering the webhook notification to third-party applications.
3. A maximum of 6 parameters are allowed. Each parameter name can be up to 25 characters.

Text
Parameter Name- 25 characters
Parameter Value- 5000 characters
Parameters in standard format (Name=Value)

1. Enter the parameter name and select the corresponding parameter value.
2. These request parameters are significant while triggering the webhook notification to third-party applications.
3. A maximum of 6 parameters are allowed. Each parameter name can be up to 25 characters.

Text
Parameter Name- 25 characters
Append custom parameters

1. Specify the parameter name and the corresponding value for the webhook.
2. A maximum of 5 parameters are allowed. Each parameter name can be up to 25 characters.
3. This key/value pair is mainly used to send auth tokens, API key, security tokens, etc.

Text
Parameter Name- 25 characters
Parameter Value- 100 characters
Custom headers 
1. Specify the header name and the corresponding value for the webhook. 
2. A maximum of 3 headers are allowed. Each header name can be up to 25 characters. 
3. This can be used to send cookie, User-Agent, Referrer, etc.  
Text
Header Name- 25 characters 
Header Value- 200 characters
Preview URL
Preview the complete webhook URL to be sent to the third-party application. This field cannot be edited. 
-
-

Constraints in webhooks

  • A maximum of 3 webhooks can be associated with a business rule. 
  • A maximum of 3 webhooks can be associated with transitions.
  • Six job related parameters and five custom parameters are allowed per webhook.
  • If a webhook execution fails after three attempts, it will be retired.

Associate webhooks with business rules

  1. Navigate to   and select Automation from the left panel.
  2. Create a new business rule or open an existing rule.  Learn more about business rules.
  3. Navigate to Actions  and click the   icon next to Configure Webhooks .
  4. Select one or more webhooks from the list of available webhooks or click Add Webhook.
  5. Click Apply.



Associate webhooks with blueprints

  1. Navigate to   and select Automation from the left panel.
  2. Create a new blueprint or open an existing blueprint. Learn more about blueprints. 
  3. Navigate to After  and click the   icon next to Configure Webhooks .
  4. Select one or more webhooks from the list of available webhooks or click Add Webhook.
  5. Click Apply.



Edit/delete webhook

To edit a webhook, navigate to Developer, select Webhooks  and click on the webhook you wish to edit. Modify the webhook and click Save.

To delete a webhook, mouse over the webhook name and click  . Select Delete from the popup and confirm your action. 




Once deleted, the webhook will no longer be associated with any blueprint.



    • Related Articles

    • 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 ...

    • 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 ...

    • 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

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