Create a rule
Create a rule that evaluates a CEL condition against incoming events and executes actions when matched. Omit rule_set_id to use the default set. Omit position to append, or use first/last/before/after placement. ACTIVE and SUSPENDED rules retain unique positions 1..N. The response includes the resulting rule_configuration_version.
condition that is evaluated against each incoming event and an actions array that executes when the condition matches. Use description to add a human-readable summary of what the rule does. Common actions include crediting balances, incrementing counters, and setting tags.
Pass rule_set_id to choose a containing set. Omit it to use the program’s default set. To place the rule, use position with first, last, before, or after. Relative placement requires the stable sibling ID in reference_id. If you omit position, Scrip appends the rule.
Scrip numbers rule positions 1..N with no gaps within each set. ACTIVE and SUSPENDED rules both occupy unique positions.
Set stop_after_match to true to prevent later rules in the same set from firing after this rule matches and its actions execute successfully. Other rule sets continue. A skipped execution, such as BUDGET_EXCEEDED, does not trigger the stop.
active_from and active_to define an optional time window using RFC 3339 timestamps. The window is checked against the event’s event_timestamp (the same value CEL sees as now), not the wall-clock time at processing. active_from is inclusive, active_to is exclusive. A matching rule outside the window records an OUTSIDE_TIME_WINDOW skipped evaluation. Event timestamps are caller-supplied, so historical imports with an event_timestamp inside a past window do fire time-windowed rules. Use these to layer promotional rules on top of permanent base rules.
budgets cap how much a rule can issue per asset over a given period. Each budget specifies an asset_id, a limit, and an optional schedule_type (CRON or INTERVAL) that controls automatic resets. Omitting the schedule type creates a lifetime budget that never resets on its own. When a budget is exhausted, the rule is skipped entirely: all of its actions are rolled back and the evaluation is recorded as skipped with a budget_exceeded reason. You can manually reset a budget via the reset budget endpoint.
A rule is created in ACTIVE status by default. You can also set it to SUSPENDED at creation. Rules cannot be created under an archived program. The response includes the resulting rule_configuration_version.
Authorizations
API key passed in the X-API-Key header.
Body
Rule with CEL condition and actions array
Request body for creating a new rule with CEL condition and actions
Actions to execute when the condition matches (must be non-empty). Each action has a type field that determines which other fields are relevant.
1Credit an asset to the target. Requires asset_id and a positive amount. reference_id, expires_at, and matures_at apply to LOT-mode assets only.
- CREDIT action
- DEBIT action
- HOLD action
- RELEASE action
- RELEASE action
- FORFEIT action
- VOID_HOLD action
- TAG action
- UNTAG action
- COUNTER action
- SET_ATTRIBUTE action
- SET_TIER action
- SCHEDULE_EVENT action
- BROADCAST action
CEL expression that determines when the rule fires
1"event.type == 'purchase'"
Display name for the rule
1 - 255"Purchase Reward"
Program to attach this rule to
"550e8400-e29b-41d4-a716-446655440000"
Start of the rule's active window (RFC 3339). Null means immediately active. Checked against the event's event_timestamp, inclusive.
"2024-01-01T00:00:00Z"
End of the rule's active window (RFC 3339). Null means no end date. Checked against the event's event_timestamp, exclusive.
"2024-12-31T23:59:59Z"
Optional budget constraints for this rule. Omit or pass null for no budgets.
Never resets. schedule_type, cron_expression, and interval are all rejected.
- Lifetime budget
- Cron budget
- Interval budget
Human-readable summary of what this rule does
1000"Awards 10 points per dollar spent"
Semantic insertion. Omit both order and position to append.
- Option 1
- Option 2
Rule set to attach this rule to. Omit to use the program's default set.
"550e8400-e29b-41d4-a716-446655440001"
Initial lifecycle status (ACTIVE or SUSPENDED). Defaults to ACTIVE.
ACTIVE, SUSPENDED "ACTIVE"
When true, no subsequent rules in this set evaluate after this one matches; other sets continue
false
Response
Rule created
Actions to execute when the condition matches
Start of the rule's active window (RFC 3339, null if always active). Checked against the event's event_timestamp, inclusive.
"2024-01-01T00:00:00Z"
End of the rule's active window (RFC 3339, null if no end date). Checked against the event's event_timestamp, exclusive.
"2024-12-31T23:59:59Z"
Budget constraints applied to this rule
CEL expression that determines when the rule fires
"event.type == 'purchase' && event.amount > 0"
When this rule was created (RFC 3339)
"2024-01-15T10:30:00Z"
When this rule was archived (null if not archived)
"2024-06-01T00:00:00Z"
Human-readable summary of what this rule does
"Awards 10 points per dollar spent"
Unique identifier for this rule
"550e8400-e29b-41d4-a716-446655440000"
Display name
"Purchase Reward"
Evaluation position within the containing rule set (lower = first; ACTIVE and SUSPENDED rules occupy unique positions)
1
Program this rule belongs to
"550e8400-e29b-41d4-a716-446655440001"
Resulting program rule-configuration revision. Present on mutation responses.
4
Rule set that contains this rule and scopes its order and stop_after_match behavior
"550e8400-e29b-41d4-a716-446655440002"
Lifecycle status: ACTIVE, SUSPENDED, or ARCHIVED
"ACTIVE"
When true, no subsequent rules in this set evaluate after this one matches; other sets continue
false
When this rule was last modified (RFC 3339)
"2024-01-15T10:30:00Z"
Non-blocking advisories about the rule's condition or action expressions, such as unknown state-key typos or deprecated CEL aliases. Present on create/update only; never blocks the save.