Loyalty rules
Rules configuration
These fields are common across all loyalty rules and define the general properties of a rule.
Basic Details
- Name & description: Enter a unique name and a brief description for the rule.
- Section: Select where this rule will appear on the loyalty page.
- Start & end time: Select when the rule becomes active. It won’t be shown before the start time. The end time is optional - if set, the rule will expire and disappear automatically.
- Required rule: Enable this to make the rule mandatory to complete before any other non-required rules can be completed.
- Hide from UI: Enable this to hide the rule from the loyalty page. Useful for background rewards or API-triggered flows.
Contract Address Section
Only shown for rules that require it. Otherwise, these fields won’t appear.- Contract address: Enter the smart contract address relevant to the rule you’re creating, such as a token contract, collection contract or a contract tied to a specific event.
- Network: Select the blockchain network where the contract is deployed.
Reward Section
Type of Reward
Choose between Points or Multiplier as the reward mechanism for this rule.- Reward: Grants a fixed number of points when the rule is completed.
- Points to reward: Enter the amount and type of points the user will earn upon completing the rule.
- Multiplier Reward: Multiply all future rewards the user earns from other rules.
- Multiplier: Enter the multiplier value applied to future rewards. This value must be greater than 1.
- Currencies to apply: Select which point types the multiplier will affect.
- Apply multiplier to user’s existing balance: Enable this to retroactively increase the user’s existing point balance based on the set multiplier.
- Update cadence: Select how often we’ll validate user completion and update their balance.
- Immediately: Completion is checked as soon as the user performs the action (e.g. answering a quiz, clicking a link).
- Daily / Weekly / Monthly: Completion is checked at the end of each period and balances are updated if completed (e.g. Twitter follower rules).
- Note: Some rules have default cadences that can’t be changed due to their logic.
- User reward frequency: Select how often a user can receive this reward.
- One time: The rule will disappear after the user completes it once.
- Daily / Weekly / Monthly: Users can complete the rule again in the next period.
- Daily resets at midnight UTC.
- Weekly resets at midnight on Monday.
- Monthly resets at midnight on the 1st of the month.
- Note: Some rules have default frequencies that can’t be changed due to their logic.