Custom Rule Actions
Custom rule actions allow you to define a unique action to take when certain conditions are met. They involve three primary components: a query pipeline, a custom rule type, and a rule that is triggered by conditions defined by the user.
To learn use custom rule actions with the API, see Create Custom Rule Actions with the API.
Configuration options
Required | Parameter | Description | Example |
---|---|---|---|
✅ |
|
A unique ID for the custom rule type. The |
|
✅ |
|
The ID of the pipeline that is invoked during rule processing. |
|
✅ |
|
A user-friendly name for the custom rule type. |
|
Rule properties, included as part of the |
|||
✅ |
|
The ID of the rule’s parameter. This field is used in the API but is not visible in the Rules Editor. |
|
✅ |
|
The type of user-input. |
|
✅ |
|
A user-friendly name for the parameter. |
|
✅ |
|
A user-friendly description of what the field is used for. The |
|