Reward Rule Set
Learn how Reward Rule Sets work
Description
Reward Rule Sets define how partners are rewarded for successful referrals. They consist of triggers (conditions that must be met) and actions (rewards that are given when conditions are met).
Properties
name
: Unique identifier for the rule setdescription
: Optional description of the rule set's purposeis_active
: Whether the rule set is currently activestarts_at
: When the rule set becomes activeends_at
: When the rule set expiresstatus_id
: Current status of the rule set
Priority System
Rule sets have different priorities based on their scope:
- Referral Link specific rules: Priority 100
- Partner specific rules: Priority 50
- Global rules: Priority 0
When multiple rules could apply, the system uses the highest priority rule set.
Triggers
Triggers define the conditions that must be met for a reward to be given. Common triggers include:
- Specific conversion types (purchase, subscription)
- Minimum conversion amounts
- Custom conditions based on the fields provided on the conversion
Actions
Actions define what happens when trigger conditions are met. They can include:
- Fixed amount rewards
- Percentage-based rewards
- Maximum reward caps
- Currency specifications
Best Practices
-
Rule Design
- Keep rules simple and clear
- Document rule purposes
-
Performance
- Monitor rule effectiveness
- Adjust rules based on results
- Remove outdated rules
- Balance reward amounts
-
Security
- Set reasonable reward caps
- Do not disable fraud checks on the projects
- Monitor for abuse
- Regular rule audits
API Integration
For detailed API documentation, check the API Reference.