LogoLogo
HomepageCase studiesBook a demo
User Guide
User Guide
  • Welcome to Open Loyalty!
  • What's New
    • 2024
    • 2023
    • 2022
  • What's Next
  • Technical Guide
  • Main Features
    • Global Management
      • Analytics
      • Settings
      • Config Duplication
      • Usage
    • Dashboard
      • General Overview
      • Units Wallet Overview
      • Additional Metrics
      • Members by Tiers
    • Members
      • Member List
        • Configuration
        • Creating Members
        • Managing Members
        • Removing Members
      • Segments
        • Creating Segments
        • Managing Segments
        • Segment Conditions
      • Referred Members
    • Campaigns
      • Creating Campaigns
        • Return Campaign
        • Referral Campaign
        • Time-Based Campaign
        • Redemption Code Campaign
        • Internal event - Achievement progressed
        • Percent value distribution
      • Managing Campaigns
      • Campaign Simulation
      • Follow-up Campaigns
    • Custom Events
      • Custom Event Schemas
    • Transactions
      • Adding Transactions
      • Managing Transactions
      • Channels
    • Tiers
      • Adding Tiers
      • Managing Tiers
      • Tiers Configuration
      • Tier Benefits
    • Wallets
      • Wallet Types and Configuration
      • Unit Transfers
        • Creating Unit Transfers
        • Importing Unit Transfers
        • Managing Unit Transfers
    • Achievements
      • Creating Achievement
      • Managing Achievements
      • Follow up Achievements
    • Rewards
      • Reward List
        • Rewards Configuration
        • Creating Reward
        • Reward Types
        • Units Conversion Coupon
        • Adding Coupons
        • Reward Flow
      • Reward Fulfillment
      • Reward Categories
    • Webhooks
      • How to Configure a Webhook
      • What Triggers a Webhook
      • Expiring Notifications
    • Collections
    • Imports / Exports
      • Imports
        • Sample Import Files
      • Exports
        • UI Data Exports
        • Configuration Exports
        • S3 Bucket Exports
    • Settings
      • Roles
      • Admins
        • System Logs
      • Tenants
      • Translations
    • Expressions
      • Attributes List
      • Operators
      • Custom Functions
      • Expression Examples
      • Sample Use Cases
        • Using Member Custom Attributes
        • Complex Effects (if, else)
        • Excluding Members
        • Elapsed Time Conditions
        • Using Additional Dates for Calculations
        • Register on Birthday
        • Transaction on Birthday
        • Tier Upgrade or Downgrade
  • Sample Setups
    • Good Practices
    • Pay with Points
    • Promo and Discounts in Cart
    • Sample Campaigns
      • #1 Earn 1 point for every $1 spent
      • #2 Earn 2x points when shopping on Monday morning
      • #3 Earn 1 stamp for every transaction
      • #4 Buy product ACME 123 and earn 100 points
      • #5 Refer a friend and get 100 points
      • #6 Refer 5 friends and get a $50 off coupon for the next purchase
      • #7 Register to the program and get 50 bonus points
      • #8 Get 30 bonus points for your first transaction in the loyalty program
      • #9 Cashback campaign
      • #10 Product meets selected criteria
    • Sample Achievements
      • #1 Celebrate summer - Buy 5 times between June and August
      • #2 Place 10 Orders above 50€ - Complete 10 transactions, for more than 50€ each
      • #3 Ambitious player - Log in to the game 3 times per week for 8 consecutive weeks
      • #4 SKU 'ABC' configuration - Spend total of 100$ on products with SKU 'ABC132' in September
      • #5 Workout track -Track a workout of at least 30 minutes for 5 days in a row
      • #6 4 referees made the transactions for 2 consecutive weeks
      • #7 2 referees made a transaction configuration
  • FAQ
    • Configuration Migration
    • Custom Attributes
    • Achievements
    • GDPR
    • Opt-Out
    • Referral Programs
    • Returns and Cancellations
    • Timezones
Powered by GitBook
On this page
  • December 2023
  • November 2023
  • October 2023
  • September 2023
  • August 2023
  • July 2023
  • June 2023
  • May 2023
  • April 2023
  • March 2023
  • February 2023
  • January 2023

Was this helpful?

  1. What's New

2023

See the complete list of features introduced back in 2023.

Last updated 1 month ago

Was this helpful?

December 2023

Dashboard Units Overview

A set of additional metrics per wallet has been added, including the metrics for issued points, pending, spent, pending, and expired, as well as redemption rate and breakage rate. It is now possible to see the amount of active points as well.

Return Transactions

A new campaign trigger has been added, allowing the specification of transaction types to streamline the return process. However, at the current moment, the functionality does not verify whether the returned items match those from the original transaction or if the quantities of products align.

Campaigns - Conditions Command bar

A new interface for selecting campaign conditions, featuring a tab named Popular Conditions has been created. This tab will utilize the browser's local storage to display recently selected conditions. Conditions will be included in this tab if they've been added at least three times.

More monthly updates

Enhanced

  • UI - Campaign View - Several improvements have been made to the campaign edit and campaign overview views, including the display of campaign visibility settings.

Fixed

  • Limitation calculation for referral campaigns - Fixed a bug where limitations were not calculated accurately.


November 2023

Dashboard - Units Overview

The Units Overview on the Dashboard in the admin panel allows for the analysis of the history of issued units by wallet type. This feature provides administrators with valuable insights into unit distribution and trends over time, directly from the dashboard interface.

Variables Catalog

Thanks to the Catalog of Variables feature adding and managing campaigns is way more convenient. We added a new module, where you can import grouped values from CSV files. Instead of typing thousands of values while creating a new condition, now it's possible to choose the whole group.

Custom Events Export to S3 Bucket

The data available for export to AWS S3 is now extended by the Custom Events file, which shows a complete list of the Custom Events that exist in the system.

More monthly updates

Added:

  • Reports data exports - Data exports (.jpg, .png, .csv) are available for the General overview report and Campaign overview report.

Enhanced:

  • Unit conversion coupon - logic change - Unit conversion coupon in Rewards module shows ratio from units to currency now.

  • Settings - Redesign UX/UI

    • List of Members: Member registration method, Identification factors settings, Member Activation, Member profile settings and Active Member settings were moved to List of Members view.

    • Timezone settings were moved to List of tenants view

    • System logs view was moved to List of Admins view

    • Help menu has a link to API documentation now

  • Achievement Completion status - Single Member View - There is additional column with a number of Achievement Completions by a Member.


October 2023

Follow-up Campaigns

Campaign Completion segment condition was added to the Segment module, and it is possible to create a segment of Members who completed a Campaign x time in a period of last x days (max of 62), last x weeks (max of 8) and last x months (max of 2). Along with the Campaign Visibility feature, it is possible to create follow-up Campaigns that are visible and available to the Members one after another, giving the option to implement additional gamification flows.

Campaign Visibility

The campaign visibility feature enables you to decide if a campaign should be shown to everyone, a specific segment, or a particular tier. This flexibility allows for targeted marketing strategies and personalized user experiences within the platform.

More monthly updates

Added:

  • Rewards fulfillment table export -A new table has an export feature added to the admin panel. Filtering and exporting the data in the table happens asynchronously.

Enhanced:

UI Improvements:

  • Single member view - Events, Available rewards, redeemed rewards

  • Exit modal for all forms

  • Breadcrumbs optimization

  • Referral token field added in Add Member form

  • Single Member View - date of birth optimization

  • Paging settings in admin panel saved on the device

  • Add/Edit Single Member view redesign

  • Maximum length of coupon code increased to 300 characters

  • List of rewards - tooltips added to availability column

  • Custom attributes - Shortening of chips component

  • Segment - Custom members list refinement


September 2023

Table Search by name

Several tables now include a search bar feature, enabling users to efficiently search for resources by name. This functionality enhances navigation and allows for quicker access to specific data within the tables.

Multiwallets Member limitation status

The status of units limitation per Member’s wallet is now visible in the Single Member View.

More monthly updates

Added:

  • Filtering transactions in the admin panel with purchase place and product custom attributes.

  • Campaign limitation status per Member - Checking the status of Campaign limitation is possible in Single Member View and API.

  • Tables - Column configurator - It is possible to configure the column visibility in tables. The setting will be stored on the device.

  • Scroll in the Tenant List - Scroll for tenant list is added. It is possible to view the higher number of Tenants.

  • Support of empty fields in Member XML import - Empty fields in Member XML import are now omitted and export is successful.

Enhanced:

UI Improvements:

  • Single member view - Custom attributes

  • Settings

  • Dropdowns

  • Cells in tables

  • Margins and buttons optimisation

  • List of Rewards revamp

  • UI revamp - Secondary button style revamp and Modal/popup revamp

Fixed:

  • Achievement status progress bar fix


August 2023

New occurrence in Achievements - In the last x days

A new Achievement occurrence allows counting the number of events (Transactions, Custom Events) in a chosen number of last days. This setting is less strict than the “In a row” occurrence, which resets the Member's progress when there is a gap in the streak. It is also possible to set up limits for triggering the rules, e.g., count only one transaction a day.

Sample business cases:

  • Log in 5 times in 7 days, once a day, and get 100 points

  • Make 5 Transactions in 30 days and get a voucher for 25$

Matching Transaction with customerId as an identification factor

Transactions can be matched with Members using customerId on top of email, phone and loyaltyCardNumber fields.

More monthly updates

Added:

  • Single member view - Achievements status

  • Added filtering based on multiple status values in GET /api/{storeCode}/redemption endpoint - It is possible to filter rewards using multiple status values simultaneously.

  • Single Transaction View - Showing many Custom Attributes - Admin panel allows viewing more Custom Attributes in a standard view and showing all Custom Attributes in a new popup.

Enhanced:

  • Single Member View - Timeline filtering - It is possible to filter the Member’s Timeline in the admin panel for different events.

  • Issued Rewards - Additional coupon information added

  • Configuration tabs adjusted

Fixed:

  • Coupon code entropy fix


July 2023

Active Members: Custom Events configuration

Configuring the definition of Active Member, including Custom Events assigned to their profile is now possible. OR/AND conditions are available to be set with transactions and Custom Events.

Rewards - Percentage coupon

The Rewards module now includes a dedicated Coupon Type specifically for percentage discounts, allowing for the direct specification of the discount percentage value. This enhancement simplifies the process by eliminating the need for Custom Attributes to define percentage discounts, offering a more streamlined approach to creating and managing percentage-based coupons.

Duplicate Campaign

You can now duplicate an existing Campaign for reuse. The new Campaign is created with “Copy” in its name and is set to inactive by default, allowing for easy modification and activation as needed.

Export Redemption Codes

Administrators now have the capability to export redemption codes directly from the admin panel.

Reward - Coupon-specific expiration date

Rewards now feature the option to set a specific expiration date for all coupons associated with a given Reward. Additionally, the expiration date can be specified at the time of coupon redemption, providing greater flexibility in managing the validity period of coupons.

More monthly updates

Added:

  • Campaign exit modal - Exit modal was added to Add Campaign form when trying to leave the Campaign without saving.

  • Export Tiers in the admin panel - Exporting the list of Members in the given Tier is now possible from the admin panel.

  • Member export - It is now possible to schedule an export of the filtered Members list. It is possible from the level of the API and Admin panel (List of Members).

  • Segment export - It is now possible to schedule an export of the Segment list. It is possible from the level of the API and Admin panel (Segments).

Enhanced:

  • Webhooks: Add multiple headers to the webhook subscription - Configuration of webhooks includes the possibility to add multiple headers to the sent webhook.

  • Add/Edit Rewards: HTML editors added to Reward description fields - An HTML editor added to Reward subscription fields allows formatting the text, which is later converted to HTML when saved on the backend side. It can be later retrieved to send formatted text in emails or other communication.

  • Single Campaign view - Campaign rules - Campaign rules are now displayed in the Single Campaign View after clicking on the Campaign in the list.

UI Improvements:

  • Campaigns - Rules

  • Single Member View - Timeline

Fixed:

  • Achievement is one of condition fix

  • Export doesn’t work for higher volumes of data

  • Data exported to AWS S3

  • Fixed 'name' filtering for GET /api/{storeCode}/member/{member}/wallet endpoint

  • It was not possible to change the order of the Campaigns.


June 2023

Single Campaign analytics

Single Campaign View was added, and it contains two metrics that can be used to track Campaign performance:

  • Total engagement: Total number of times the campaigns engaged members within the set date range.

  • Engaged members: Total number of members engaged with the campaigns at least once within the set date range.

More monthly updates

Enhanced:

  • Add/Edit Campaign form revamp

  • Single Campaign View - details

  • Adding additional labels for daily aggregation on the General Overview and Campaign reports

Fixed:

  • Accent sign-in email fix

  • customerId value fix for GET /api/{storeCode}/points/{transfer} and GET /api/{storeCode}/points/

  • Cancelling particular units transfer caused 500 error

  • Canceling units transfers causing 500 error

  • Expression length is too short causing 500 error


May 2023

Multi-dimensional achievements

Open Loyalty supports the creation of hybrid achievements by combining various triggers.

These are sample cases:

  • Share a post on social media and make a purchase for at least 50$

  • Walk 10,000 steps five days in a row and buy three products from the supplements category

Segmentation based on location and age

This feature allows for refined targeting by incorporating demographic and geographical criteria such as country, city, province, and postal code.

Specify Wallet for the Reward

Now, for each Reward, you can designate a specific Wallet from which units will be redeemed. This feature is accessible through both the Add/Edit Reward form in the admin panel and via API, offering greater flexibility in managing rewards and redemptions.

Admin Panel Import UI

The admin panel now includes a user interface for the import functionality, enabling a new method for importing Members directly through the admin Panel. This update simplifies the process of adding members to the system, enhancing the user experience and administrative efficiency.

More monthly updates

Added:

  • Creating Member without adding the Tier - It is now possible to use Open Loyalty without creating Tiers. Before, there had to be a basic Tier; now, Members can be created without any Tier assigned.

  • Logout after a period of inactivity - An automatic logout is performed when there is no activity for some time. The default value is 15 minutes.

  • Redemption codes export to CSV file - It is now possible to manage the exports of redemption codes.

    • POST /api/:storeCode/campaign/{id}/codes/export is used to schedule an export. It is also possible to use filtering in order to export the desired list of codes.

    • GET /api/:storeCode/export/{exportId} is used to get the details of the scheduled export.

    • GET /api/:storeCode/export/{exportId}/download is used to download the exported file.

    • GET /api/:storeCode/export is used to get the list of all scheduled exports.

  • API - Items on page limited to 50

Enhanced:

  • Filtering improvement - when clicking on the “chips” the edit option is displayed - It is possible to edit the filter by clicking on the “chips” component.

UI Improvements:

  • UI forms performance enhancements

  • Copy for Campaign table

Fixed:

  • Create a Campaign with specific data - 500 status error

  • Changing Member password causing 500 HTTPS error

  • System logs username filtering 500 error

  • List of Members - filtering with “Amount excluded for Tier” 500 error

  • Missing items in CSV exports


April 2023

Units Conversion Coupon

It is now possible to create a new coupon type that allows converting the Member’s units to a monetary value. It simplifies the management of coupons and enables burning points to just one high-value coupon rather than several lower-value ones. This approach helps to engage the Members more and drive sales.

Redemption (QR) Codes Campaigns

This new Campaign mechanic allows the creation of a set of codes that will yield an effect(Rewards, Units, etc) to the Member who is scanning it. OL can generate and validate the codes that can be presented in any desirable way (string, QR codes, bar codes, etc) to the Member. One of the cases involves printing the codes on the products to encourage customers to buy them.

Dashboard - General overview of active members

It is now possible to configure the Active Member definition in Settings. The definition takes into account the number of days that passed from the last Transaction of a given Member. Then Open Loyalty will gather and display the analytics data on these Members.

More monthly updates

Enchanced:

  • Add/Edit Rewards - There is a new layout for the Add/Edit Rewards form.

Fixed:

  • Filtering Members using memberId

  • Sorting Rewards by type caused 500 error

  • Filtering Rewards using Tiers caused 500 error

  • Update Add/Edit role view- dropdown of Tenant and select component of "Access" and "Resource"

  • Right to left mode admin panel improvements

  • Creating Segment with “Members with custom attribute value”, “Members with custom attribute” conditions admin panel error

  • Hiding unused fields when adding deduct units transfer

  • PUT /api/{storeCode}/member/{member} email update error

  • Timeline Unit Transfer dates fix

  • Achievement concurrency issue


March 2023

Multi-level referrals

It is now possible to set up the number of levels for which the referral Campaign will be triggered. For example for Referral Level = 2, and situation: Mary invites John and John invites Kate and Kate makes a transaction. In this case, both John (Level 1 referral) and Mary(Level 2 referral) will get the Campaign Effect(Points, Rewards, etc.). It is also possible to vary the Rewards based on the given level of Referral so that Mary can get a different Reward than John.

Dashboard - General Overview

New Dashboard element - General overview with various metrics was added.

New metrics include:

  • Registered members

  • Revenue

  • Avg. spending

  • Transactions

  • Avg. transaction value

  • Avg. number of transactions

More monthly updates

Added:

  • Asynchronous Member import with XML file - It is now possible to import multiple xml files with Members and track the progress of the import.

Enhanced:

  • Admin panel translations - Translations were enhanced in multiple places making the experience of using the panel better

  • Set/Delete Member Custom Attribute effect enhanced in CampaignEffectWasApplied webhook - Information about the key and value of the assigned Custom Attribute has been added to the webhook CampaignEffectWasApplied

  • Using loyaltyCardNumber, email and phone as memberId with endpoints - It is possible to use loyaltyCardNumber, email and phone, instead of memberId (uuid) using all endpoints that used memberId as a path parameter

  • transferId added to AvailablePointsAmountChanged webhook

Fixed:

  • Set Member Custom Attribute Effect and PUT /api/DEFAULT/member/{member}/custom-attribute request did not trigger the Campaign

  • Error enhancement when deleting segment that contains Members

  • Single Member View - different value for empty field: “-” instead of “NaN”

  • Changing a member's email resets its data

  • Fixed wrong Transaction and Unit Transfer date on Member timeline

  • Layout improvements

  • Error status code for deleting segments fixed


February 2023

Export to S3 - Achievements progress

It is possible to export Achievements progress as a CSV file to the S3 bucket.

Export to S3 Bucket

It is possible to export Transactions, Rewards Redemption, Achievements as CSV files to the S3 bucket.

Campaign Effect - Assign/Delete Member CustomAttribute

There are two new Effects added in Campaigns:

  • Set Member Custom Attribute - it allows setting the Custom Attribute on the Member profile as an effect of a Campaign. Use cases: assigning badges, assigning custom units to be rewarded ratio, custom segmentation, chaining Campaigns

  • Delete Member Custom Attribute - it allows deleting Custom Attributes from the Member profile.

Additionally, it is possible to use numerical Member Custom Attributes in Campaigns in Effects, e.g. give units with custom individualised ratio for each Member.

More monthly updates

Added:

  • RTL - Right-to-left support in admin panel - The admin panel is in right-to-left mode for Arabic and Hebrew language browser settings.

  • Set a new password by administrator in admin panel - It is now possible to set a Member password in Admin panel.

  • There is a wallet type code displayed in Admin panel for the default wallet. - Before this code was not shown but currently it is displayed as with their wallet types.

Enhanced:

  • Achievements - Read-only mode - The edit achievement form is displayed in a read-only mode. When updating non-condition fields i.e. name, description, the progress achievements stay the same. When updating conditions the prompt is shown informing that the progress of achievements will change.

  • transferId added to AvailablePointsAmountChanged webhook

  • Matching transaction: Matching from Single Transaction View and showing explicit matching information - It is now possible to match a Transaction to a Member on Single Transaction view. Additionally, it is shown explicitly if Transaction is matched or not.

  • Add/Edit new wallet type UI revamp- Layout for Add/Edit wallet type changed in Admin Panel

  • Campaigns in Admin panel - Conditions revamp: event.achievementId and purchaseAmount It is possible to set two new conditions in Campaigns:

    • For Transaction Campaigns: Purchase amount - the value of all Transactions placed by a Member

    • For Internal Event - Achievement progressed: Name of the progressed Achievement (before it was necessary to use the expression)

Fixed:

  • Display Edit Campaign page in admin panel

  • 400 error when editing image in Rewards

  • Fixes in migration scripts

  • Filtering units transfers as logged Member returned only default wallet transfers

  • Edit Tier image 401 error

  • Achievement - Transaction items custom attributes condition did not progress the achievement

  • Wrong hover in Rewards details in Admin panel

  • Admin panel - error with opening Achievements with brackets in Conditions


January 2023

Export to S3 Bucket - Campaigns Usage, Members, Campaigns, Tiers

It is possible to export Campaigns Usage, Members, Campaigns, and Tiers as CSV files to the S3 Bucket.

Global limitations

It is now possible to set a global limitation. There are two configurations:

  • global wallet limitation - limit for all the wallets of the given type

  • member wallet limitation - separate limit for wallets of the given type per Member

It is possible to set different time constraints: hourly, daily, weekly, monthly, yearly and in total.

More monthly updates

Enhanced:

  • Admin Panel UI improvements - Navigation bar has been moved to the side and is now collapsible.

  • Single Member View - expiration date for units transfers added

  • Additional actionCause object added to AvailablePointsAmountChanged webhook New object added to the webhook: "actionCause": { "campaignId": "string" (uuid) | null, "customerId": "string" (uuid) | null, "transactionId": "string" (uuid) | null, "customEventId": "string" (uuid) | null, "internalEventName": "string" | null } It gives information about a cause that triggered the event.

Fixed:

  • Audit logs - opening some logs resulted in a blank screen

  • Coupons - daysInactive and daysValid validation fixed

  • Tier downgrade config fixed

  • Units to the next tier calculated for the wrong wallet

  • Export to s3 - CSV had breaks in the wrong places

  • Member edit returned 500

  • Reward edit error - image deleted

  • Units transfer cancellation fix

  • Too many decimals for Units on Single Member View in the admin panel

  • Filtering using customerId fix

  • Cannot search the condition after choosing an item from the list

  • A long email address is displayed outside the box

  • GET /member/{memberID}/status returned value calculated with the wrong wallet

  • Concurrent add units operation resulted in duplicating the wallet type for the single Member

  • Campaign Limitation - The campaign showed the wrong limitation after the edit