Skip to main content
Using an AI coding assistant? Connect Cursor, Claude, or Copilot to Snag Docs for context-aware help. Learn how.

Overview

Loyalty rules define how users earn points, multipliers, or badges in your loyalty program. Each rule type has specific requirements for parameters, metadata, and configuration. This guide covers all available rule types and their required fields.

Common Parameters

All loyalty rules share these common parameters:
string
required
The organization ID that owns this rule.
string
required
The website ID where this rule will be applied.
string
required
The name of the loyalty rule (max 255 characters).
string
Optional description of the rule.
LoyaltyRuleType
required
The type of loyalty rule. See available types below.
LoyaltyRuleFrequency
required
How often eligibility is checked. Options: once, daily, weekly, monthly, immediately.
LoyaltyRuleInterval
How often users can earn rewards. Options: once, daily, weekly, monthly, unlimited, custom.
ISO8601 string
required
When the rule becomes active (ISO 8601 format).
ISO8601 string
Optional end time for the rule (ISO 8601 format).
LoyaltyRuleRewardType
required
Type of reward: points, multiplier, or badge.
string
required
The ID of the loyalty currency (points) to reward.
NetworkType
required
The blockchain network. Options: mainnet, goerli, polygon, arbitrum, etc.

Reward Configuration

Reward Types

Reward users with points for completing actions.
number
required
The number of points to reward.
string
required
ID of the currency to reward with.

Rule Types

Rule types are grouped below to match the categories shown in the loyalty dashboard. Each type only reads the metadata (and top-level) fields listed for it — omit the rest.

User Onboarding

Complete Profile Details (profile_completed)

Reward users for completing their profile.
Record<string, boolean>
Which profile fields must be filled. Keys: profile_picture, name, location, nft_portfolio, about, email, twitter, discord, telegram, evm, solana, sui, ton, imx. If omitted, a default set is checked (bio, avatar, X, Discord, email).

Refer a Friend (referred_user)

Reward users for referring others.
number
required
Points for the referred user.
number
required
Points for the referrer.
string
Currency for referrer reward.
boolean
Require referred users to achieve points.
number
Required points when achievePoints is true.
boolean
Require complete profile.
boolean
Require Twitter connection.
boolean
Require Discord connection.
boolean
Require email connection.

Check In (check_in)

Reward users for checking in.
number
required
Points for each check-in.
boolean
Enable streak tracking for consecutive check-ins.
Array<Streak>
Optional array of streak milestones and rewards.
number
required
Number of consecutive days for this streak.
number
required
Points awarded for reaching this milestone.

Connect Accounts

Reward users for connecting an account. Most connection rules need no metadata — pass an empty object "metadata": {}. The remaining connection rules take metadata:

Connect X (connected_twitter)

boolean
Apply a higher reward to verified (blue-check) accounts.
number
Multiplier applied when enableVerifiedMultiplier is true (e.g. 1.5).

Connect Discord (connected_discord)

boolean
Require users to also join specific Discord servers.
Array<DiscordServer>
Servers (and optionally channels/roles) users must join.
string
required
Discord server ID.
Array<Channel>
Channels to verify activity in.
Array<Role>
Optional roles to verify.

Connect Wallet (connect_wallet)

WalletType
required
Which wallet type the user must connect (e.g. evm, solana).

Social Quests

X (Twitter) engagement rules generally require oauthCredentialsId (top-level) so the platform can verify activity, and many accept an optional verified-account multiplier (metadata.enableVerifiedMultiplier, metadata.verifiedMultiplier).

React to an X Post (drip_x_tweet)

string
required
URL of the X post to engage with.
string
required
Twitter user ID of the post author.
boolean
Require liking the post.
boolean
Require reposting.
boolean
Require commenting.
string
Twitter OAuth credentials (top-level field).

Post on X (drip_x_new_tweet)

string | Array<string>
Text that must be included in the tweet.
boolean
Require users to submit post link (default: true).
boolean
Require post to include media.

Follow an X Account (drip_x_follow, twitter_follow)

string
required
X account to follow.
string
required
Twitter user ID of the account.
string
required
OAuth credentials for Twitter (top-level field).
drip_x_follow accepts the account as metadata.twitterAccountUrl (full profile URL) instead of username/ID.

Add Text to X Bio / Username / Comment (drip_x_text_in_bio, drip_x_text_in_name, drip_x_text_in_comment)

string | Array<string>
required
Text that must appear in the user’s bio, display name, or comment.
boolean
(drip_x_text_in_comment) Only reward posts that pass quality/sentiment checks.
number
(drip_x_text_in_comment) Minimum follower count to qualify.

Reach X Followers (twitter_followers)

Array<RewardAmountRange>
required
Tiered rewards by the user’s follower count.

Get X Post Impressions (post_impressions)

Array<RewardAmountRange>
required
Tiered rewards by post view/impression count.
boolean
Only reward posts that pass quality/sentiment checks.
number
Minimum follower count to qualify.
boolean
Optional top-level flag to track progress. mediaUrl (top-level) can supply a media reference.

Repost an X Post (Retweet)

string
required
Twitter user ID of the account whose posts are monitored for reposts.

Like an X Post (twitter_like)

string
required
Account that posted the tweet.
string
required
Twitter user ID.
string
required
OAuth credentials (top-level field).

Comment on an X Post (twitter_comment)

string
required
Twitter user ID of the account whose posts are monitored for comments.

Post on X with Hashtag (twitter_post_hashtag)

string
required
Hashtag to search for in recent posts.

Get an X Post Liked by Project (tweet_liked_by_project)

string
required
Twitter user ID of the project account whose like qualifies the user.
string
required
OAuth credentials for Twitter (top-level field).
boolean
Multiply the reward by the tweet’s impression count.

Get Discord Role (discord_member)

Array<DiscordServer>
required
Servers and roles to verify. Each item uses id and roles.

Join Discord Server (discord_join)

Array<DiscordServer>
required
Servers the user must join. Only the server id is required for this type.

Send Discord Messages (DiscordMessages)

Array<DiscordServer>
required
Server id and the channels whose messages count. Each channel can specify text to match and emojis reactions.
Array<RewardAmountRange>
Optional tiered rewards based on message count.

Grant a Discord Role (discord_role_grant)

Array<DiscordServer>
required
Server id plus the roles to grant. roles is required for this type.
string
required
Discord server (guild) ID.
Array<Channel>
Channels to check. Each: { id: string, text?: string, emojis?: Array<{ id: string }> }. Used by DiscordMessages.
Array<{ id: string }>
Roles to verify or grant. Required for discord_role_grant.

Join Telegram Group (telegram_join)

string
required
ID of the Telegram channel the user must join.

Send Telegram Messages (telegram_messages)

string
required
ID of the Telegram channel whose messages count.
Array<RewardAmountRange>
Optional tiered rewards based on message count.

Follow a TikTok Account (tiktok_follow)

string
required
TikTok profile URL to follow (e.g. https://www.tiktok.com/@username). Despite the field name, this holds the TikTok URL.

Post on TikTok (tiktok_post)

string | Array<string>
Text to check in post.
boolean
Require post link submission.
LoyaltyPostRewardCriteria
IMPRESSIONS_COUNT or ELIGIBLE_POST.

Post on Instagram (instagram_post)

string | Array<string>
required
Text or hashtag the post must include.
boolean
Only reward posts that pass quality checks.
number
Minimum follower count to qualify.

Follow an Instagram Account (instagram_follow)

string
required
Instagram profile URL to follow (e.g. https://www.instagram.com/username). Despite the field name, this holds the Instagram URL.

Subscribe to a YouTube Channel (youtube_subscribers)

string
required
YouTube channel ID the user must subscribe to.
string
Optional Google API integration ID (top-level field) used for verification.

Comment on a YouTube Video (youtube_comment)

string
required
YouTube video ID the user must comment on.
string
Optional Google API integration ID (top-level field) used for verification.

Comment on a Reddit Post (reddit_comment)

string
required
ID of the Reddit post users must comment on.
string
required
Full URL of the Reddit post.

Add an Item to Steam Wishlist (steam_wishlist)

string
required
Steam application ID the user must wishlist.

Spend in Shopify Store (shopify_spend)

string
required
Shopify store domain (top-level field).
string
required
Shopify admin API access token (top-level field).
Array<RewardAmountRange>
Range-based rewards by purchase amount.

Token Activity

Mint an NFT (MintOn)

Reward users for minting NFTs.
Array<Collection>
required
Collections to track (top-level field).
boolean
Only reward users who have never sold the token.
Array<RewardAmountRange>
Optional tiered rewards.

Purchase an NFT (BoughtOn)

Reward users for purchasing NFTs.
Array<Collection>
required
Collections to track (top-level field).
boolean
Only reward existing users.
boolean
Only reward users who never sold the token.
Array<RewardAmountRange>
Optional tiered rewards.

Hold an NFT (TokenHold)

Reward users for holding specific NFTs.
Array<Collection>
required
Collections to track (top-level field).
boolean
Only reward existing users.
boolean
Reward only one token ownership per contract.
Array<RewardAmountRange>
Tiered rewards by number of tokens held.

Sell an NFT (SoldOn)

Reward users for selling NFTs.
boolean
Filter by specific sale currency.
string
Currency address when hasSaleCurrency is true.
Array<RewardAmountRange>
Optional tiered rewards.

Hold a Fungible Token (token_hold_erc20)

Reward users for holding ERC20 tokens.
boolean
Reward based on USD value held rather than token count.
boolean
Apply a multiplier per holding tier instead of fixed points.
Array<RewardAmountRange>
Tiered rewards by amount held.

Swap a Token (swap)

Reward users for token swaps.
string
any, relay, or lifi.
string
Relay referrer ID when provider is relay.
object
Source-token filter: { mode: "any" | "specific", chain, tokens, trackAmount }.
object
Destination-token filter: { mode: "any" | "specific", chain, tokens, trackAmount }.
boolean
Require cross-chain swaps.

Hold tokens in Robinhood (robinhood_token_hold)

Array<string>
required
Token symbols to track (e.g. ["TRUMP", "SPY"]).
Array<RewardAmountRange>
Optional tiered rewards by holding amount. Falls back to top-level amount if omitted.

Complex Onchain Logic

Smart Contract Event (smart_contract_event)

Reward based on smart contract events.
string
required
Contract address to monitor (top-level field).
string
Event signature to track.
SmartContractCriteria
everyEvent or specify conditions.
Array<Param>
Event parameter filters.
string
Address parameter name in event.

Stratus Function (stratus_function)

Custom on-chain logic executed by a Stratus function; the function controls reward output.
string
required
ID of the Stratus function to run (top-level field).
string
Optional Stratus subscription ID (top-level field).
boolean
Optionally route rewards to the dApp owner. When true, rewardType must be points and network is required.

Provide Liquidity on Uniswap V2 / V3 (liquidity_uniswap_v2, liquidity_uniswap_v3)

NetworkType
required
Chain for liquidity pools.
string
required
Protocol identifier (e.g., “uniswap-v2/eth-usdc”).
Array<Pool>
Array of liquidity pool addresses (max 20, same network/protocol).
LiquidityCalculationType
required
fixed or custom.
number
USD value per day (when calculationType is fixed).
string
Custom calculation formula (when calculationType is custom).

Developers Contribution

Star / Fork / Become a Collaborator (github_repo_star, github_repo_fork, github_repo_collaborator)

string
required
Repository URL. Must match https://github.com/<owner>/<repo>.

Merge a GitHub PR (github_merge_PR)

string
required
Repository URL. Must match https://github.com/<owner>/<repo>.
string
Target branch to count merged PRs against. Defaults to main if omitted.
Array<RewardAmountRange>
Optional tiered rewards by number of merged PRs.

Other

Submit Text Input (text_input)

string
Placeholder text for the input field.
number
Minimum character length required.

Enter a Code (code_entry)

Reward users for entering promo codes.
PromoCodeType
required
Type: code, csv, or generate.
string
Single shared code (when promoCodeType is code).
string
CSV URL with unique codes (when promoCodeType is csv).
number
Number of codes to generate (when promoCodeType is generate).
boolean
Only allow new users (last 6 hours) to redeem.
URL the user clicks.
number
Delay (1–600 s) before the reward is granted.
SocialPlatform
Platform shown for the link (e.g. X, Discord, or Custom).
string
Label on the action button.

Answer a Quiz (quiz)

string
required
Question text.
Array<Choice>
Answer options with isCorrect flag. Exactly one choice must be correct.

Answer a Poll (poll)

string
required
Poll question text.
Array<Choice>
Answer choices.
boolean
Allow users to vote multiple times.

Participate in Governance Vote (snapshot_governance)

Array<{ id: string, space: string }>
required
Snapshot proposal(s) to track. One proposal per rule.

Create a Partner Account (create_partner_account)

Partner site URL. Must match the partner auth domain.
string
Label on the action button.

External Rule (external_rule)

Custom rules managed by external services.
number
required
Base points amount.
boolean
Track completion progress (top-level field).
Array<RewardAmountRange>
Range-based rewards with custom amounts.
boolean
Multiply reward by number of actions.
string
Description of what the external rule tracks.

Points Airdrop (points_airdrop)

Airdrop points to specific users via CSV.
string
required
CSV URL with wallet addresses and point amounts (top-level field).
boolean
Track processing progress.

dApp Activity

Rank and reward dApps by on-chain activity. These rules rely on several top-level fields in addition to metadata.range, and route rewards to the dApp owner (isDappRule). Applies to: dapps_by_gas_spent, dapps_by_active_users, dapps_by_new_users, dapps_by_transaction_count.
Array<RewardAmountRange>
required
Tiered rewards by rank/threshold for the chosen metric.
LoyaltyRuleInterval
required
Data window for the metric: daily, weekly, or monthly. Leave empty for all-time.
LoyaltyRuleInterval
Optional filter limiting to dApps deployed within this window.
boolean
Routes rewards to the dApp owner. Immutable after creation.
NetworkType
required
Blockchain network for the rule (required when isDappRule is true).
dapps_by_user_retention appears in the dashboard but is not yet implemented — creating it will fail. Use one of the four supported dApp metrics above.

Range-Based Rewards

Some rules support range-based rewards with tiered amounts:
Array<RewardAmountRange>
Array of reward ranges.
number
required
Minimum value for this range.
number
required
Maximum value (use Number.MAX_SAFE_INTEGER for unlimited).
number
required
Points awarded for this range.
string
Optional badge for this range.

Range Examples

Advanced Configuration

Max Reward Limits

number
Maximum points users can earn in the interval.
LoyaltyRuleMaxAmountInterval
Interval period: daily, weekly, monthly.

Claim Type

LoyaltyRuleClaimType
manual (user must claim) or auto (auto-rewarded).

Reward Lifetime

LoyaltyRuleRewardLifetime
For multipliers/badges: permanent (never removed) or dynamic (removed if requirements not met).

Airdrop Duration

ISO8601
When airdrop becomes effective.
ISO8601
When airdrop ends.

Validation Examples

Error Handling

All required fields must be provided. Missing required fields will result in a 400 Bad Request error with details about which fields are missing.
Range values must not overlap. The start range should be less than or equal to the end range for each range entry.
For Ultra networks (Ultra/UltraTestnet), the collection address format is address::symbol. For example: accountname::TOKEN.
Use the loyaltyCurrencyId field consistently across rules to ensure proper currency management in your loyalty program.

Rule Type Limitations and Restrictions

Multiplier Reward Type Support

The multiplier reward type is NOT supported for the following rule types:
  • check_in
  • link_click
  • referred_user
  • points_airdrop
Only points and badge reward types are available for these rules.

Claim Type Support

Different rule types support different claim types (manual vs auto-reward):
These rules require users to manually claim rewards:
  • check_in
  • text_input
  • poll
  • quiz
  • create_partner_account
  • telegram_join
  • drip_x_follow
  • drip_x_tweet
  • drip_x_new_tweet
  • swap

Reward Lifetime Options

The rewardLifetime field (for multipliers and badges) has different support levels:
Most rules only support permanent lifetime where rewards never expire:
  • check_in
  • twitter_followers
  • Retweet
  • BoughtOn, SoldOn, MintOn
  • twitter_like, twitter_comment, twitter_post_hashtag
  • profile_completed, referred_user
  • poll, quiz
  • Most social and connection rules
With permanent lifetime, once a user qualifies for the reward, they keep it forever even if they stop meeting requirements.
These rules support both permanent and dynamic lifetime:
  • TokenHold - Most flexible, supports both
  • external_rule - Can expire if user stops meeting requirements
With dynamic lifetime, rewards are removed if the user no longer meets the requirements (e.g., sold their NFT).

Interval Restrictions

Some rules have limited interval options:
Rules with frequency: immediately typically only support interval: once or specific intervals.Rules with frequency: none may support custom intervals.

Range-Based Rewards

Range-based rewards are ONLY supported for:
  • TokenHold
  • BoughtOn, SoldOn, MintOn
  • token_hold_erc20
  • twitter_followers (with rewardCriteria)
  • external_rule (with trackProgress)
  • shopify_spend
Range-based rewards require the metadata.range array. Maximum range value is Number.MAX_SAFE_INTEGER (use this for unlimited).

Network-Specific Limitations

For Ultra and UltraTestnet networks, collection addresses require a symbol suffix: address::symbol (e.g., accountname::TOKEN)

Token Holdings

ERC20 token holding rules (token_hold_erc20) require network support for USD price tracking. Networks without USD support will disable the rewardPerValue option.

Liquidity Pool Limits

Liquidity rules support a maximum of 20 pools per rule, all within the same network and protocol with the same factory address.

Shopify Integration

Shopify spend rules require providing both shopifyStoreUrl and shopifyStoreAccessToken. The access token is used for one-time authentication during rule creation but is not stored.