---
title: Rules
description: Every rule can have an optional trigger. The trigger is the guard that decides if a rule is triggered or not. If a rule does not have a trigger the rule will always be executed. Every rule has a name.…
url: "https://2yetis.net/docs/rules/"
updated: "2024-01-02"
category: Rule Engine
---

# Rules

Every rule can have an optional trigger. The trigger is the guard that decides if a rule is triggered or not. If a rule does not have a trigger the rule will always be executed.

Every rule has a name. The name is used to identify the rule and should be unique at least in the module.

Configuration:

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| name | string | n/a | Name of the rule. Use a descriptive name. The name of a rule is similar to the function name in other languages |
| triggers | expression | n/a | An expression used to evaluate if the rule should be triggered. If the expression is true, the rule will be triggered |
| Type | Filter, Map, Script | n/a | The type of rule defined. See below to learn more about rule types. |

There are three types of rules: filter rules, mapping rules and script rules.