Manage Webhooks

Webhooks Overview

Webhooks facilitate automated HTTP notifications. Notifications are triggered in third-party applications as per the business requirements when a predefined action is performed by the user in the organization.

Business Use Cases of Webhooks

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

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

Add webhook

1. Navigate to   and select Webhooks under Advanced  from the menu.
   
2. Click  New Webhook  button.
   
3. Enter the details. Refer the below table to know the specification of each field. 
   
4. Click Save .
   

List of fields in Webhook configuration

Field Name	Description	Data Type	Limit
Type	Choose between 'Standalone' and 'Board'. Standalone webhooks can be used in all Boards.	Dropdown	-
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	-
Credential	Credential is a central storage repository where all your database credentials can be stored and accessed while initiating a new connection. Learn More	Dropdown	-
Execute in Bridge	On opting this, webhook details will be sent to Bridge and the corresponding API is triggered. This option is helpful while working with internal APIs.	Checkbox	-
Bridge/Cluster	Select a bridge or a load-balancing cluster listed in the dropdown	Dropdown
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 its corresponding value for the webhook. 2. Maximum of 5 parameters are allowed. Each parameter name can have 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 a  transition .
  
• Six card  related parameters and five custom parameters are allowed per webhook.

Associate Webhooks with Business Rules

1. Navigate to   and select  Business Rules under  Automation from the menu. (or)
   
2. Navigate to board specific business rules using quick access settings. Learn more.
3. Create a new business rule or open an existing rule.  Learn more about business rules.
   
4. Fill in the rule details and move to  Criteria & Actions.
   
5. Now ,  click the  icon next to  Instant Actions or Schedule Actions and select Webhooks  from the dropdown.
   
6. Select one or more webhooks from the list of available webhooks or click Add Webhook .
   
7. After the webhook is selected, Click  Apply .
   
8. Click Save. 
   

Associate Webhooks with Blueprints

1. Navigate to  Boards  , hover over any specific board in the left panel and click     to choose  Manage Board . (or)
   
2. Navigate to  to select a board. Learn more.



3. Navigate to Step 2: Design Blueprint. 
   
4. Click on a transition and navigate to  After  section in the right panel. 
   
5. Now, under Instant Actions or Schedule Actions , click the  icon next to  Configure Webhooks .
   
6. Select one or more webhooks from the list of available webhooks or click Add Webhook .
   
7. Click  Apply .
   
8. Save the Blueprint.  
   

Edit/delete Webhook

To edit a webhook, select Webhooks under Advanced  from the menu , click on the webhook you wish to edit. Modify the webhook and click  Save .

To delete a webhook, hover 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

• Manage Business Rules

  What is a business rule? A business rule helps you trigger an event or a chain of automated events, when a defined action occurs in a card. For example, when a card's assignee field is updated, you might want to change the card's supervisor field ...

• Send Email

  Automated emails allow for comprehensive communication in today’s organizations. Use them to inform your team about the progress of a card or notify specific users when the card moves to the next stage. Configure automated emails by choosing an email ...

• Customize Email Templates

  Overview of email templates Communication is key in any organization. It often becomes a challenge to track the myriad of ongoing tasks in a huge team. Qntrl helps your team overcome this challenge and stay informed via notifications and emails. ...

• Business case 3: Use client scripts to fetch data from third party applications or websites

  While designing forms, we might sometimes want to display data from other websites or applications like stock rates, flight status, freight details, weather updates, and so on. To fetch such information from third party websites or applications and ...

• Qntrl Marketplace - An Overview

  Qntrl Marketplace is an online store with solutions for specific business requirements while working with Qntrl. This is the perfect platform to search for any Qntrl extensions or showcase the extension you have built, which extends the capabilities ...