# Rule

Type: object

Schema: [Rule](https://sourcey-firefly.pages.dev/api/models/rule/index.md)

- `created_at` (optional)
  Type: string, date-time
  
  readOnly: true
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `updated_at` (optional)
  Type: string, date-time
  
  readOnly: true
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `title` (required)
  Type: string, string
  
  Example:
  
  ```json
  "First rule title."
  ```

- `description` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "First rule description"
  ```

- `rule_group_id` (required)
  Type: string, string
  
  ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory.
  
  Example:
  
  ```json
  "81"
  ```

- `rule_group_title` (optional)
  Type: string, string
  
  Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory.
  
  Example:
  
  ```json
  "New rule group"
  ```

- `order` (optional)
  Type: integer, int32
  
  readOnly: true
  
  Example:
  
  ```json
  5
  ```

- `trigger` (required)
  Reference: [RuleTriggerType](https://sourcey-firefly.pages.dev/api/models/ruletriggertype/index.md); Type: string, string
  
  Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation.
  
  enum: ["store-journal","update-journal","manual-activation"]
  
  Example:
  
  ```json
  "store-journal"
  ```

- `active` (optional)
  Type: boolean
  
  Whether or not the rule is even active. Default is true.
  
  default: true
  
  Example:
  
  ```json
  true
  ```

- `strict` (optional)
  Type: boolean
  
  If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true.
  
  Example:
  
  ```json
  true
  ```

- `stop_processing` (optional)
  Type: boolean
  
  If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false.
  
  default: false
  
  Example:
  
  ```json
  false
  ```

- `triggers` (required)
  Type: array
  
  Items:
    Reference: [RuleTrigger](https://sourcey-firefly.pages.dev/api/models/ruletrigger/index.md); Type: object

- `actions` (required)
  Type: array
  
  Items:
    Reference: [RuleAction](https://sourcey-firefly.pages.dev/api/models/ruleaction/index.md); Type: object