Create a rule
Create a rule that evaluates a CEL condition against incoming events and executes actions when matched.
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.
The order field controls evaluation priority. Lower values are evaluated first. If omitted, order is auto-assigned above the current highest value in the program. No two active rules in the same program can share the same order. Leave gaps between values (e.g. 10, 20, 30) so you can insert new rules without reordering.
Set stop_after_match to true to prevent lower-priority rules from firing when this rule matches.
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.
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.
1CEL 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.
Human-readable summary of what this rule does
1000"Awards 10 points per dollar spent"
Evaluation sequence (lower = first). Auto-assigned if omitted.
x >= 1100
Initial lifecycle status (ACTIVE or SUSPENDED). Defaults to ACTIVE.
ACTIVE, SUSPENDED "ACTIVE"
When true, no subsequent rules evaluate after this one matches
false
Response
Rule created
Actions to execute when the condition matches
[
{
"amount": "${{ event.amount * 10 }}",
"asset_id": "550e8400-e29b-41d4-a716-446655440002",
"type": "CREDIT"
}
]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 sequence (lower = first, must be unique per program)
100
Program this rule belongs to
"550e8400-e29b-41d4-a716-446655440001"
Lifecycle status: ACTIVE, SUSPENDED, or ARCHIVED
"ACTIVE"
When true, no subsequent rules evaluate after this one matches
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.