Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.finwatch.finance/llms.txt

Use this file to discover all available pages before exploring further.

A Rule is the fundamental building block in FinFlows. It acts as a named container that groups a set of conditions with a corresponding action. Each .ws file must contain exactly one rule, and the rule’s name should be unique across the system. The engine identifies rules by their name, which is used for logging, tracking, and debugging. Structure 
rule HighValueTransactionAlert {
    description "Flags any transaction exceeding 10,000 for review."

    when
        amount > 10000

    then
        review
        score 0.7
        reason "Transaction amount exceeds the $10,000 threshold."
}
  • rule HighValueTransactionAlert { ... }: Defines the rule and its unique name.
  • description: An optional but highly recommended string that explains the rule’s purpose. This is used for documentation and appears in monitoring tools.