Back

Category balance reaches threshold

This trigger fires when a category's remaining balance crosses a dollar amount you specify — either rising above or dropping below the threshold.

Developer info

API endpoint slug: eclosion.category_balance_threshold

Trigger fields

Category Dropdown list

Label: Which category do you want to monitor?
Helper text: The budget category to watch
Slug: category
Required: true
Can have default value: false

Threshold amount Text input > Regular expression

Label: What dollar amount is your threshold?
Helper text: The dollar amount to compare against the category's remaining balance
Slug: threshold_amount
Required: true
Can have default value: true

Direction Dropdown list

Label: Should it trigger above or below the threshold?
Helper text: Fire when the balance goes above or below the specified amount
Slug: direction
Required: true
Can have default value: true

Ingredients

Created at Date and time event was created.

Slug: created_at
Filter code: Eclosion.categoryBalanceThreshold.CreatedAt
Type: Date with time (ISO8601)
Example: 2020-07-08T04:17:06+05:00

Category name The name of the budget category whose balance crossed the threshold.

Slug: category_name
Filter code: Eclosion.categoryBalanceThreshold.CategoryName
Type: String
Example: Fun Money

Current balance The category's current remaining balance for this month.

Slug: current_balance
Filter code: Eclosion.categoryBalanceThreshold.CurrentBalance
Type: String
Example: 250

Threshold The dollar threshold amount that was configured for this trigger.

Slug: threshold_amount
Filter code: Eclosion.categoryBalanceThreshold.Threshold
Type: String
Example: 200

Direction Whether the balance went above or below the configured threshold.

Slug: direction
Filter code: Eclosion.categoryBalanceThreshold.Direction
Type: String
Example: above