Campaigns
In this section, you will get to know everything related to Campaigns.

Campaigns module overview

Campaigns work based on triggers, conditions, and Rewards. After the trigger occurs, conditions are checked based on trigger attributes, and a Reward is given. This functionality allows you to Reward the customer if they meet the conditions set out in the campaign.
For example, all customers whose name is John and who made a $20 purchase will receive 15 Units.

Adding Campaigns

To add a new Campaign, log in to the app as an Administrator, and click on the Campaign tab on the left side menu, a list will expand with 3 options:
  • List of Campaigns
  • Add new Campaign
  • Simulate Campaign
There are 2 options you can either click directly on the "Add new Campaign" button and find yourself on the "Add Campaign" screen or click on the "List of Campaigns", here you will land on the table with already created Campaigns and above it, in the right side the purple button "Add Campaign" is present.
After accessing the "Add Campaign" screen you need to fill in the required information to create the Campaign suiting you best.
First, you need to choose which Campaign you are willing to create. For now, there are two options available:
  • Direct Campaign - the one-sided Campaign where you can add rules for a Members
  • Referral Campaign - the two-sided Campaign where you can add rules for Referrer and Referee
  • Birthday Campaign - the Campaign where you can add rules for Member who has a birthday
These two types decide on which triggers and conditions will be based on your Campaign.
You can add more than one rule with different conditions and effects by clicking on the purple button "Add rule".
Please note that if you add e.g. 1 rule with 2 different conditions, both conditions must be met in order to reward a Member. But if you create two rules, only one of them must be fulfilled, because they are considered separately as each rule has its own effect.
If you would like to remove the previously added condition just click on the "x" button on the right-hand side.
After you have picked all of the necessary parameters just click on the "Add Campaign" button, a cordial celebration of your successful launch will appear and you will land on the Campaigns screen, where you can find your freshly created Campaign.

Custom event

If you chose the "Custom Event", note that the "Event name" dropdown list will be empty if there weren't any "Custom Event schemas" created before. Therefore if you want to be able to use this trigger, please first create a 'Custom Event schema' that you would like to base your Campaign on. Then, if you click on the "Event name", a list with created options will appear along with a condition that you have created in "Custom Event schemas". It will be displayed on the conditions list during creating the "Custom Event" - based Campaign.

Campaign attributes

Campaign attributes can store various types of data in a key:value format. We can use these data to filter campaigns in the Admin Panel, via the API or use this data in external applications for management and filtering. e.g. Display to a member a campaign that is available only to new members
Please note that if you would prepare the Campaign and would like to change its trigger after putting all data, the form will be cleared from already put information.

Direct Campaign

When you choose this type of Campaign, in the next step you need to select the trigger on which you want to base your Campaign.
  • Transaction - the Campaign is triggered by a Transaction
  • Custom Event - the Campaign is triggered by a Custom Event
  • Internal Events - the Campaign is triggered by actions that take place in the system
  • Achievement - The Campaign is triggered by the completion of the Achievement
  1. 1.
    Fields you need to fill in, in the "Transaction" based case:
    • Campaign name
    • Short description - optional
    • + Translation - here you can add implemented already a translation
    • Start date
    • End date - optional but if put, please note it must be after the start date
    • Campaign attributes - optional attributes of the campaign used for additional data or filtering
    • Active - if you will not mark this checkbox your Campaign will not be active
    • Rules
      • Condition - this condition will trigger your Campaign. For example, each Member whose name is Jack and who made a $100 purchase(conditions) will receive 20 Units.
      • Effect - you will need to click on the purple button, the list with two options will appear
        • "Give Units" - select formulas to add, divide, multiply, and subtract your values.
        • "Give Reward" - select the Reward that the Member who fulfills the conditions will receive
  2. 2.
    Fields you need to fill in, in the "Internal Event" based case:
    • Event name - choose the Action on which the Campaign will be based
    • Campaign name
    • Short Description - optional
    • + Translation - here you can add implemented already a translation
    • Start date
    • End date - optional but if put, please note it must be after the start date
    • Active - if you will not mark this checkbox your Campaign will not be active
    • Campaign attributes - optional attributes of the campaign used for additional data or filtering
    • Rules
      • Condition - here you must pick conditions type from the list and add its condition and value. It will trigger your Campaign.
      • Effect - click on the purple button, and the list with two options will appear
        • Give Units - select formulas to add, divide, multiply, and subtract entered values
        • Give Reward - select the Reward that the Member who fulfills the conditions will receive
  3. 3.
    Fields you need to fill in, in the "Custom Event" based case:
    • Event name - choose the Event Schema on which the Campaign will be based
    • Campaign name
    • Short Description - optional
    • + Translation - here you can add implemented already a translation
    • Start date
    • End date - optional but if put, please note it must be after the start date
    • Campaign attributes - optional attributes of the campaign used for additional data or filtering
    • Active - if you will not mark this checkbox your Campaign will not be active
    • Rules
      • Condition - here you must pick a conditions type from the list and add its condition and value. It will trigger your Campaign.
      • Effect - click on the purple button, and the list with two options will appear
        • Give Units - select formulas to add, divide, multiply, and subtract entered values
        • Give Reward - select the Reward that the Member who fulfills the conditions will receive

Referral Campaign

If you have chosen this type of Campaign, the next thing you can do is choose the trigger on which your Campaign will be based.
  • Transaction - the Campaign is triggered by a Transaction
  • Custom Event - the Campaign is triggered by a Custom Event
  • Internal Events - the campaign is triggered by actions that take place in the system
  1. 1.
    Fields you need to fill in, in the "Transaction" based case:
    • Campaign name
    • Short Description - optional
    • + Translation - here you can add implemented already a translation
    • Start date
    • End date - optional but if put, please note it must be after the start date
    • Active - if you will not mark this checkbox your Campaign will not be active
    • Campaign attributes - optional attributes of the campaign used for additional data or filtering
    • Rules
      • Condition - this condition will trigger your Campaign. For example, each member whose name is Jack and who made a $100 purchase(conditions) will receive 20 Units.
      • Effect - you will need to click on the purple button, the list with two options will appear
        • "Give Units" - select formulas to add, divide, multiply, and subtract your values.
        • "Give Reward" - select the Reward that the Member who fulfills the conditions will receive
  2. 2.
    Fields you need to fill in, in the "Internal Event" based case:
    • Event type - choose the Action on which the Campaign will be based (such as 'Member was activated')
    • Campaign name
    • Short Description - optional
    • + Translation - here you can add implemented already a translation
    • Start date
    • End date - optional but if put, please note it must be after the start date
    • Active - if you will not mark this checkbox your campaign will not be active
    • Campaign attributes - optional attributes of the campaign used for additional data or filtering
    • Rules
      • Condition - here you must pick conditions type from the list and add its condition and value. It will trigger your Campaign.
      • Effect - click on the purple button, and the list with two options will appear
        • Give Units - select formulas to add, divide, multiply, and subtract entered values
        • Give Reward - select the Reward that the Member who fulfills the conditions will receive
  3. 3.
    Fields you need to fill in, in the "Custom Event" based case:
    • Event name - choose the Event Schema on which the Campaign will be based
    • Campaign name
    • Short Description - optional
    • + Translation - here you can add implemented already a translation
    • Start date
    • End date - optional but if put, please note it must be after the start date
    • Active - if you will not mark this checkbox your Campaign will not be active
    • Campaign attributes - optional attributes of the campaign used for additional data or filtering
    • Rules
      • Condition - here you must pick a conditions type from the list and add its condition and value. It will trigger your Campaign.
      • Effect - click on the purple button, and the list with two options will appear
        • Give Units - select formulas to add, divide, multiply, and subtract entered values
        • Give Reward - select the Reward that the Member who fulfills the conditions will receive
Referee - Person invited to the program Referrer - Member sending the invitation
The 'Rules' section is divided into the 'Rules for Referrer' and 'Rules for Referee' sub-sections. There, you can create conditions you would like to apply respectively for Referrer, for Referee, or for both, and reward them accordingly.
Please note that rules are considered separately, which means that if you e.g. create a Campaign with rules for Referrer and Referee but only one of them will meet the conditions, only this Member will be rewarded.

Birthday Campaign

This Campaign type is based on the date of birth of an existing Member in the system. If you want to reward Members on their birthday, you should use this Campaign. Each day at 00:00 Members who celebrate their birthday will receive the reward that is specified in the Campaign.
This means if a member's account is created on his birthday, the member will not be rewarded in the campaign, since the rewards are given only at 00:00 AM.
You can create a birthday campaign that includes members registered at their birthday using expressions.
Fields you need to fill:
  • Campaign name
  • Short Description - optional
  • + Translation - here you can add implemented already a translation
  • Start date
  • End date - optional but if put, please note it must be after the start date
  • Active - if you will not mark this checkbox your Campaign will not be active
  • Campaign attributes - optional attributes of the campaign used for additional data or filtering
  • Rules
    • Condition - here you must pick a conditions type from the list and add its condition and value. It will trigger your Campaign.
    • Effect - click on the button, and the list with two options will appear
      • Give Units - select formulas to add, divide, multiply, and subtract entered values
      • Give Reward - select the Reward that the Member who fulfills the conditions will receive

Managing Campaigns

To see all created Campaigns you need to click on "List of Campaigns". Here, on the "Campaigns" screen, you will have them all presented in the table. You can filter out searched records, you can edit them, and create a new one.
Below you will find described operations that you can perform on Campaigns.

Browsing Campaigns list

As mentioned above you can see all created Campaigns displayed in the table, data which are presented here:
  • Name
  • Campaign type
  • Active
  • Active from
  • Active to
  • Created at
There is a possibility to sort records by clicking on the column header for Name, Active, Active from, and Active to - when hovering over the header you may notice that the mouse cursor change to the hand, and arrows appears.
There is also a possibility of filtering records by clicking on the "+Add filter" button and applying the picked condition. After that only records which will meet the required condition should be present. Also, statistics of how many records are created and how many of them meet the condition's criteria, are presented. Available conditions you can pick to filter out your results:
  • Active
  • Active from
  • Active to
  • Campaign ID
  • Name
  • Type
After applying the picked filter it appears in front of the "+Add filter" button, as a purple, pillow button which can be dismissed by clicking on "X". You can apply more than one condition at once.
In case the applied filter should not have any results present, such a label will be displayed instead of records.

Updating a Campaign

If you would like to edit the Campaign which was created before, pick this specific Campaign and click on the overflow button, a shortlist with the "Edit" option will appear - click it.
Now you will land on edit Campaign view - here you can make expected changes and save new Campaign configuration.
How to edit in steps:
  1. 1.
    Select the Campaign
  2. 2.
    Click the context menu
  3. 3.
    Click "Edit"
  4. 4.
    Make a changes
  5. 5.
    Click “Save”

Autocomplete

This feature helps you when filling in the 'Give Units' text field. When you will click on the text field and start typing, after the first two letters - the list with the suggested Templates or Variables will appear. You can mix the formulas (add, divide, multiply, and subtract) to obtain the expected result.
All available formulas you can use for the Campaigns:
  • Templates
    • Fixed amount of 100 Units
    • 10 Units for every product with specific SKU
    • 20 Units for every product from the specifc brand
    • 1 Unit for every 1 unit of currency spent
    • 1 Unit for every 10 units of currency spent and roundup the value of units
    • 1 Units for every 1 unit of currency spent, 2x units for every product from the specific category
    • 2 Units for every 1 unit of currency spent, exclude products from the specific brand
    • 5 Units for every 1 unit of the currency spent on the product from the specific brand
  • Variables
    • Transaction gross value
    • Total number of items in transaction
    • Quantity of products with specific SKU
    • Gross value of products with specific SKU
    • Quantity of products from specific category
    • Gross value of products from specific category
    • Quantity of products from specific brand
    • Gross value of products from specific brand
  • round_down()
  • round_up()
Besides the formulas, you can use already prepared templates, by clicking on the '+' button, where the searchable list will appear.
To choose the formula you can use the button "˅". Clicking on this button will open a list with optional formulas.
If any of your typed formulas will have a mistake, a message about the problem appears after trying to save the campaign.

Limitations

Campaign limitation is one of the ways to incorporate anti-fraud into loyalty programs. These are based on different conditions in three main categories, namely: Global - relating to the entire campaign Individual - relating to the account of a single member Usage - how many times a member can receive points for a specific action.
When using this functionality, you are able to define how many units a single campaign is able to generate, with no breakdown per member; specify the maximum number of units a member is able to receive within a campaign, as well as how many times a member can receive units for fulfilling campaign conditions.
For example: Set an overall limit for the entire campaign of 10000 units, as well as a limit of 100 units for one member. As a result, I know that a minimum of 100 users can join the campaign, and each of them will be able to earn a maximum of 100 units.
Each of these limits can be set for a specific period of time during which it is enforced.
Timestamps:
  • No limit - the Campaign is not limited
  • Daily - Member can earn a specific number of units every x calendar days For example: Limit for number of units: In last n calendar days Number of days: 3 Maximum number of units: 230 Each Member in every 3 days from today (2022.04.12 00:00 - 2022.04.15 00:00) can earn 230 units
  • Weekly - Member can earn a specific number of units every x calendar weeks For example: Limit for number of units: In last n calendar weeks Number of weeks: 5 Maximum number of units: 150 Each Member in every 5 weeks from this week (2022.04.11 00:00 - 2022.05.15 00:00) can earn 150 units
  • Monthly - Member can earn a specific number of units every x calendar months For example: Limit for number of units: In last n calendar months Number of months: 0 Maximum number of units: 15 Each Member in every 0 month from this month (2022.05.01 00:00 - 2022.05.31 00:00) can earn 15 units
  • Yearly - For example: Limit for number of units: In last n calendar months Number of years: 0 Maximum number of units: 1 500 Each Member in every 0 years from this year (2022.01.01 00:00 - 2022.12.31 00:00) can earn 1 500 units
  • In total - this limit is set for the entire lifetime of the Campaign
Types of limits:
  1. 1.
    Limit for number of units - here you can set the general maximum number of Units to earn for all Members.
  2. 2.
    Limit for number of units per member - here you can set the maximum number of Units for each Member.
  3. 3.
    Limit for number of triggers per member - here you can set the maximum number of triggers for each Member.

Simulate Campaign

This function allows you to simulate the Reward effect that will be returned when the Member will meet the Campaign conditions. The simulation helps to check whether the Campaign you have created contains the correct conditions and whether the Reward is returned correctly.
You can simulate direct or Referral Campaigns. If you would like to simulate the Referral Campaign, please note that you need to fill the 'Member details' section along with the 'Referrer details' to simulate rewards for both sides.
Simulation form
E.g.
Create a Referral Campaign with conditions:
Rules for referrer: Referrer first name is equal to John and Reward is equal to 80 Units
Rules for referee: Referee first name is equal to John and Reward is equal to 120 Units
Then go to simulation, fill in all required fields and enter Member(Referee) and Referrer first name. After simulating Member, you should see an effect in the results with a Reward of 120 Units for Member and 80 for Referrer.
In the simulated results, you may notice a distinction to whom the Reward will be granted.
Simulation results for Member and Referrer
E.g. Create a Direct Campaign with a conditions: First name is equal to John and Reward is equal to 140 Units Then go to the simulation, fill in all the required fields and enter the first name, John. After simulating the Campaign, you should see an effect in the results with a Reward of 140 Units for Member.
Simulation result only for Member
The simulation form contains 4 sections:
  • Member details
  • Referrer details
  • Campaign trigger
  • The last one depends on which trigger you will pick:
    • Transaction details
    • Event details (if you will choose Internal event or Custom Event)
After running the simulation 'Simulated Campaigns' and 'Simulated results' will appear. Here you may notice which Campaigns criteria were met along with who and what Reward may receive.

Business case

“Referrers earn 1% cash on all revenue generated by their referred customers”

FAQ (Campaigns)

Copy link
On this page
Campaigns module overview
Adding Campaigns
Direct Campaign
Referral Campaign
Birthday Campaign
Managing Campaigns
Browsing Campaigns list
Updating a Campaign
Autocomplete
Limitations
Simulate Campaign
Business case
FAQ (Campaigns)