For the complete documentation index, see llms.txt. This page is also available as Markdown.
Webhook & API
Introduction
Webhook Rules is a pivotal component within the Automate system, providing the capability to define conditions that trigger specific actions based on incoming webhook requests.
The primary purpose of Webhook Rules is to automate responses and actions within flows by defining rule sets that respond to external events received via webhooks. This component enhances the flexibility and automation capabilities of the system.
What are Webhook Rules?
Webhook Rules allow users to create sets of conditions that dictate how the system should respond when specific webhook events occur. These rules enable seamless integration with external systems, enabling automated actions based on real-time data triggers.
Key Features
Dynamic Triggers: Create rules based on various parameters such as headers, queries, or request bodies.
Customizable Responses: Define specific actions or responses for each rule set.
Easy Configuration: Intuitive interface for setting up and managing webhook rules.
Usage of the Component
Creating a New Rule
A rule is a set of conditions that define how the system should react to incoming webhook events.
1
Navigate to Webhook & API Rules
Access the "Webhook & API Rules" page under the management section.
Click the "Add Webhook Rule" button to create a new rule.
2
Details
Rule Name: Provide a descriptive name for the rule.
Description: Add details explaining the purpose or function of the rule.
3
Rule Configuration
Select Parameter Type: Choose from header, query, or body.
Enter Key: Define the key for the selected parameter.
Operation: Specify the operation to be performed (e.g., equals, contains, starts with).
Target Value: Input the value to compare against the parameter.
4
Response Action
Define the action or response to be triggered when the rule conditions are met.
5
Add Rule
Click the "Add Rule" button to save the rule.
Managing Rule Sets
Once rules are created, they can be organized into rule sets for easier management.
1
Create Rule Set
Group related rules together for streamlined management.
Edit, delete, or add new rules within the rule set.
2
Edit Rule
Modify existing rules within a rule set.
3
Delete Rule
Remove unwanted rules from the rule set.
Applying Rules to Flows
Rules can be applied to specific flows to trigger automated actions based on incoming webhook events.
1
Select Flow
Choose the flow to which the rule should be applied.
2
Link Rule Set
Associate a rule set with the selected flow.
3
Save Changes
Ensure to save the configuration to apply the rules to the flow.
