# RuleTrigger

Type: object

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

- `id` (optional)
  Type: string, string
  
  readOnly: true
  
  Example:
  
  ```json
  "2"
  ```

- `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"
  ```

- `type` (required)
  Reference: [RuleTriggerKeyword](https://sourcey-firefly.pages.dev/api/models/ruletriggerkeyword/index.md); Type: string, string
  
  The type of thing this trigger responds to. A limited set is possible
  
  enum: ["from_account_starts","from_account_ends","from_account_is","from_account_contains","to_account_starts","to_account_ends","to_account_is","to_account_contains","amount_less","amount_exactly","amount_more","description_starts","description_ends","description_contains","description_is","transaction_type","category_is","budget_is","tag_is","currency_is","has_attachments","has_no_category","has_any_category","has_no_budget","has_any_budget","has_no_tag","has_any_tag","notes_contains","notes_starts","notes_end","notes_are","no_notes","any_notes","source_account_is","destination_account_is","source_account_starts"]
  
  Example:
  
  ```json
  "user_action"
  ```

- `value` (required)
  Type: string, string
  
  The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger.
  
  Example:
  
  ```json
  "tag1"
  ```

- `prohibited` (optional)
  Type: boolean
  
  If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc.
  
  default: false
  
  Example:
  
  ```json
  false
  ```

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

- `active` (optional)
  Type: boolean
  
  If the trigger is active. Defaults to true.
  
  default: true
  
  Example:
  
  ```json
  true
  ```

- `stop_processing` (optional)
  Type: boolean
  
  When true, other triggers will not be checked if this trigger was triggered. Defaults to false.
  
  default: false
  
  Example:
  
  ```json
  false
  ```