This guide was created to help you navigate through the Scrimmage Rewards Program. If you have any questions, ideas, or feedback, feel free to get in touch via [email protected].

Scrimmage is a white-label rewards program that can be integrated into existing apps and websites. On average, the addition of the Scrimmage Rewards Program boosts engagement by 5x for users in the program. Integration can be completed within one day.

How the rewards work

You have complete control over the rewards program. You can specify the rewards available to your users, the actions that trigger these rewards, and the frequency of rewards. These rewards can be redeemed for gift cards, an increase in their internal balance, or spent within the rewards program itself for additional enhancements.

Scrimmage's team is always ready to assist you with the setup and customization of the rewards program. We can help you develop and maintain a version of the rewards software tailored to your needs.

The user experience is simple:

1. Users perform actions on your app or website.
2. Users accept quests, prompting additional action within the app.
3. Users level up, progressing through the loyalty program.
4. Users cash out their rewards for gift cards, increase their internal balance, or obtain additional enhancements.

Loyalty Program Components

The Scrimmage Rewards Program requires collaboration between the loyalty program manager and developers. Below you will find brief descriptions of the components.

• Scrimmage Admin Dashboard - The main tool for managing the loyalty program. A link to the dashboard will be provided by the Scrimmage Team.
• Events - Actions that users take on your app & website. These are sent from your app to Scrimmage.
• Event Properties - Additional data that is sent with the event. For example, if the event is "User First Deposit," the event property could be the amount of the deposit. Then, the reward for this event could be calculated based on the amount of the deposit.
• Users - The users of your app & website who participate in the loyalty program.
• Rewards - The prizes that users can earn: coins, perks, quests, statuses, etc.
• Redeem Options - The ways users can spend their rewards: gift cards, internal balance, etc.

Additionally, some components can be used in the loyalty program:

• Reward Rules - Permanent rules that define how rewards are calculated. User did X, so they get Y.
• Quests - A series of actions that users need to complete to earn a reward. User did X several times, so they get Y.
• Perks - Perks work similarly to the reward rules, but users can have a limited number of perks and must choose which one to use.
• Achievements - Special rewards for completing a series of actions. User did X, Y, and Z, so they get A.
• User Properties - Additional data about the user that can be used in the reward rules. For example, the user's country, age, amount of money spent, amount of actions performed, etc.

First Configuration

Below are the steps to configure the bare minimum of the loyalty program. This will allow you to start testing the program and see how it works.

1. Get an account

Email [email protected] to request access to the admin dashboard.

2. Create Secret Key

After you receive access to the admin dashboard, you need to create a Secret Key. This key will be used to send events to Scrimmage.

Navigate to the Settings > Secret Keys section of the admin dashboard. Click Generate New Key and copy the key.

🚧

Keep your Secret Key secure and safe.

You can only see the Secret Key once. Do not share it with anyone or lose it. If you lose it, you will need to generate a new one.

3. Register the first user

Each event must be associated with a user. This can be done by executing the following code:

curl -X POST \
  https://<your-org-id>.apps.scrimmage.co/api/integrations/users \
  -H 'Authorization: Token <your-secret-key>' \
  -H 'Scrimmage-Namespace: <your-namespace>' \
  -H 'Content-Type: application/json' \
  -d '{ "id": "<user-id>" }'

See Create a user if not exists endpoint.

Replace the placeholders with your data:

• <your-org-id> - your organization ID
• <your-secret-key> - the Secret Key you generated
• <your-namespace> - your namespace. Most likely it will be production
• <user-id> - the ID of the user in your system. It can be anything.

In response, you will receive the user ID you provided and a token. You can ignore the token for now.

4. Send an event

Now you can send an event. This can be done by executing the following code:

curl -X POST \
  https://<your-org-id>.apps.scrimmage.co/api/integrations/rewards \
  -H 'Authorization: Token <your-secret-key>' \
  -H 'Scrimmage-Namespace: <your-namespace>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "<user-id>",
    "dataType": "<event-type>",
    "body": {
      "property1": "value1"
    }
  }'
 

See Record a rewardable event endpoint.

Replace the placeholders with your data:

• <your-org-id> - your organization ID used in the previous step
• <your-secret-key> - the Secret Key you generated
• <your-namespace> - your namespace used in the previous step
• <user-id> - the ID of the user you registered in the previous step
• <event-type> - the type of the event. For example, user_first_deposit

In response, you will receive the event ID.

5. Check the dashboard

Now you can check the admin dashboard. You should see the event you sent in Logs and the user in Users.

Hooray 🎉! You have successfully configured the loyalty program.

Next Steps

• Event integration with your backend
• Frontend integration
• Redeem options setup
• Customization of the rewards program