# Open Loyalty

## User Guide

- [Welcome to Open Loyalty!](https://help.openloyalty.io/getting-started.md): This guide was created to help you navigate through Open Loyalty Admin UI. If you have any questions, ideas, or feedback, feel free to get in touch via www.openloyalty.io.
- [What's New](https://help.openloyalty.io/whats-new.md): Discover the latest features and improvements that make OpenLoyalty even better.
- [2026](https://help.openloyalty.io/whats-new/2026.md): Keep up to date with all released features and improvements!
- [2025](https://help.openloyalty.io/whats-new/2025.md): Keep up to date with all released features and improvements!
- [2024](https://help.openloyalty.io/whats-new/2024.md): See the complete list of features introduced back in 2024.
- [2023](https://help.openloyalty.io/whats-new/2023.md): See the complete list of features introduced back in 2023.
- [2022](https://help.openloyalty.io/whats-new/2022.md): See the complete list of features introduced back in 2022.
- [What's New - OL](https://help.openloyalty.io/whats-new-ol.md): Keep up to date with all released features and improvements!
- [What's Next](https://help.openloyalty.io/whats-next.md)
- [Global Management](https://help.openloyalty.io/main-features/global-management.md): In this page you will see what metrics are included in the Global Managment overview.
- [Analytics](https://help.openloyalty.io/main-features/global-management/analytics.md): In this section, you will learn how to read the Open Loyalty global analytics.
- [Settings](https://help.openloyalty.io/main-features/global-management/settings.md): In this section, you will learn how to manage the Open Loyalty settings.
- [Config Duplication](https://help.openloyalty.io/main-features/global-management/config-duplication.md): In this section, you will learn how to duplicate the configuration of your loyalty program between tenants.
- [Usage](https://help.openloyalty.io/main-features/global-management/usage.md)
- [Dashboard](https://help.openloyalty.io/main-features/dashboard.md): The dashboard is the first page that appears when you log in to the Admin panel. The dashboard gives an overview of the members' activity in your loyalty programs.
- [General Overview](https://help.openloyalty.io/main-features/dashboard/general-overview.md): The dashboard is the first page that appears when you log in to the Admin panel. The dashboard gives an overview of the members' activity in your loyalty programs.
- [Units Wallet Overview](https://help.openloyalty.io/main-features/dashboard/units-wallet-overview.md): The dashboard is the first page that appears when you log in to the Admin panel. The dashboard gives an overview of the members' activity in your loyalty programs.
- [Additional Metrics](https://help.openloyalty.io/main-features/dashboard/addtional-metrics.md): The dashboard is the first page that appears when you log in to the Admin panel. The dashboard gives an overview of the members' activity in your loyalty programs.
- [Members by Tiers](https://help.openloyalty.io/main-features/dashboard/members-by-tiers.md): The dashboard is the first page that appears when you log in to the Admin panel. The dashboard gives an overview of the members' activity in your loyalty programs.
- [Members](https://help.openloyalty.io/main-features/members.md): In this section, we will cover everything related to Loyalty Program Members. We will show you all the operations you can do on each Member and what you can achieve with them.
- [Member List](https://help.openloyalty.io/main-features/members/member-list.md): In this section, we will cover everything related to the list of members. We will show you how to manage, add, remove and anonymize Members' data, and you will understand Members data better.
- [Creating Members](https://help.openloyalty.io/main-features/members/member-list/adding-members.md): In this section, you will discover how to add individual members as well as multiple members.
- [Managing Members](https://help.openloyalty.io/main-features/members/member-list/managing-members.md): In this section, you will learn how to edit Members' data.
- [Single Member View](https://help.openloyalty.io/main-features/members/member-list/single-member-view.md)
- [General Info](https://help.openloyalty.io/main-features/members/member-list/single-member-view/general-info.md)
- [Wallets](https://help.openloyalty.io/main-features/members/member-list/single-member-view/wallets.md)
- [Timeline](https://help.openloyalty.io/main-features/members/member-list/single-member-view/timeline.md)
- [Tiers](https://help.openloyalty.io/main-features/members/member-list/single-member-view/tiers.md)
- [Transactions](https://help.openloyalty.io/main-features/members/member-list/single-member-view/transactions.md)
- [Custom events](https://help.openloyalty.io/main-features/members/member-list/single-member-view/custom-events.md)
- [Campaigns](https://help.openloyalty.io/main-features/members/member-list/single-member-view/campaigns.md)
- [Challenges](https://help.openloyalty.io/main-features/members/member-list/single-member-view/challenges.md)
- [Achievements (legacy)](https://help.openloyalty.io/main-features/members/member-list/single-member-view/achievements-legacy.md)
- [Rewards](https://help.openloyalty.io/main-features/members/member-list/single-member-view/rewards.md)
- [Referrals](https://help.openloyalty.io/main-features/members/member-list/single-member-view/referrals.md)
- [Badges](https://help.openloyalty.io/main-features/members/member-list/single-member-view/badges.md)
- [Leaderboards](https://help.openloyalty.io/main-features/members/member-list/single-member-view/leaderboards.md)
- [Custom Fields](https://help.openloyalty.io/main-features/members/member-list/single-member-view/custom-fields.md)
- [Removing Members](https://help.openloyalty.io/main-features/members/member-list/removing-members.md): In this section, you will discover various methods for removing members' data.
- [Segments](https://help.openloyalty.io/main-features/members/segments.md): In this section, you will learn how segmentation works in Open Loyalty. How to configure Member Segments according to your preferences, how to create new Segments, and assign Members to existing ones.
- [Creating Segments](https://help.openloyalty.io/main-features/members/segments/creating-segments.md): Learn how to create dynamic or static segments and import a custom member list into a static segment.
- [Managing Segments](https://help.openloyalty.io/main-features/members/segments/managing-segments.md): Edit segments, activate or deactivate them, export member lists, and remove unused segments.
- [Segment Conditions](https://help.openloyalty.io/main-features/members/segments/segment-conditions.md): In this section, you will find a list of conditions that you can base your segments on.
- [Referred Members](https://help.openloyalty.io/main-features/members/referred-members.md): In this section, you will find detailed information about the Referee and Referrer members, which will help you manage the Referral System in Open Loyalty.
- [Custom Fields](https://help.openloyalty.io/main-features/members/custom-fields.md): This article explains how custom fields can be created and used in your loyalty program.
- [Configuration](https://help.openloyalty.io/main-features/members/configuration.md): In this section, you will learn how to manage the loyalty program configuration.
- [Campaigns](https://help.openloyalty.io/main-features/campaigns.md): In this section, you will get to know everything related to Campaigns.
- [Automation Campaigns](https://help.openloyalty.io/main-features/campaigns/automation-campaigns.md): In this section, you will learn about Automation Campaigns.
- [Creating Automations](https://help.openloyalty.io/main-features/campaigns/automation-campaigns/creating-automations.md): In this article, you will learn how to create automation campaigns.
- [Managing Automations](https://help.openloyalty.io/main-features/campaigns/automation-campaigns/managing-automations.md): In this article, you will learn how to manage automation campaigns.
- [Deleting Automations](https://help.openloyalty.io/main-features/campaigns/automation-campaigns/deleting-automations.md): In this article, you will learn how to delete automation campaigns.
- [Campaigns & Referral Campaigns](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns.md): Learn how to configure and monitor your campaigns.
- [Creating Campaigns](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns.md): Learn more about campaign types and how to create one.
- [Trigger Types](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns/trigger-types.md): Learn more about campaign trigger types and which one to choose for your campaigns.
- [Purchase Transaction](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns/trigger-types/purchase-transaction.md)
- [Return Transaction](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns/trigger-types/return-transaction.md)
- [Internal Event](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns/trigger-types/internal-event.md)
- [Achievement Progressed](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns/trigger-types/internal-event/internal-event-achievement-progressed.md): Learn more about the campaign based on the achievement progression.
- [Custom Event](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns/trigger-types/custom-event.md)
- [Achievement](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns/trigger-types/achievement.md)
- [Redemption Code](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns/trigger-types/redemption-code-campaign.md): Learn more about campaign based on the redemption codes.
- [Referral Campaign](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns/referral-campaign.md): Learn more about referral campaigns.
- [Transaction Item Filters](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns/transaction-item-filters.md): Transaction Item Filters enable precise targeting within loyalty campaigns by allowing you to isolate specific products in a customer's purchase.
- [Percent Value Distribution](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/creating-campaigns/percent-value-distribution.md): Learn more about campaign based on the percent value distribution.
- [Managing Campaigns](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/managing-campaigns.md): In this article, you will learn how to manage campaigns.
- [Deleting Campaigns](https://help.openloyalty.io/main-features/campaigns/campaigns-and-referral-campaigns/deleting-campaigns.md): In this article, you will learn how to delete campaigns.
- [Monitoring & Analytics](https://help.openloyalty.io/main-features/campaigns/monitoring-and-analytics.md)
- [Campaign Simulation](https://help.openloyalty.io/main-features/campaigns/campaign-simulation.md): Learn how you can check the expected campaing outcome.
- [Campaign Limitation](https://help.openloyalty.io/main-features/campaigns/campaign-limitation.md): Learn how you can enforce campaign limitations to set a campaign budget or prevent fraud.
- [Custom Attributes in Campaigns](https://help.openloyalty.io/main-features/campaigns/custom-attributes-in-campaigns.md): Learn how you can use custom attributes in campaigns
- [Custom Units Expiration & Pending Settings](https://help.openloyalty.io/main-features/campaigns/custom-units-expiration-and-pending-settings.md): Learn more how you can set custom expiration and pending setting for the units awarded in the campaign.
- [Effects Autocomplete](https://help.openloyalty.io/main-features/campaigns/effects-autocomplete.md): Learn more about available autocomplete options for the effects, and how to use templates and variables.
- [Using Expressions](https://help.openloyalty.io/main-features/campaigns/using-expressions.md)
- [Follow-up Campaigns](https://help.openloyalty.io/main-features/campaigns/follow-up-campaigns.md): Create campaign chains where completing one campaign unlocks the next. Visibility and availability controls are supported in Campaigns, Referral Campaigns, and the new feature, Challenges.
- [Challenges](https://help.openloyalty.io/main-features/challenges.md): This section explains how Challenges can be created and used in your loyalty program.
- [Creating Challenges](https://help.openloyalty.io/main-features/challenges/creating-challenges.md)
- [Managing Challenges](https://help.openloyalty.io/main-features/challenges/managing-challenges.md)
- [Deactivating and Deleting Challenges](https://help.openloyalty.io/main-features/challenges/deactivating-and-deleting-challenges.md)
- [Leaderboards](https://help.openloyalty.io/main-features/leaderboards.md): In this section, we will cover everything related to Leaderboards.
- [Creating Leaderboards](https://help.openloyalty.io/main-features/leaderboards/creating-leaderboards.md): This article explains how leaderboards can be created and used in your loyalty program.
- [Rewarding Cycle](https://help.openloyalty.io/main-features/leaderboards/rewarding-cycle.md)
- [Managing and Viewing Rankings](https://help.openloyalty.io/main-features/leaderboards/managing-and-viewing-rankings.md)
- [Single Member Ranking](https://help.openloyalty.io/main-features/leaderboards/single-member-ranking.md)
- [Sample Leaderboards](https://help.openloyalty.io/main-features/leaderboards/sample-leaderboards.md)
- [Fortune Wheels](https://help.openloyalty.io/main-features/fortune-wheels.md): In this section, we will cover everything related to Fortune Wheel.
- [Creating Fortune Wheels](https://help.openloyalty.io/main-features/fortune-wheels/creating-fortune-wheels.md): This article explains how to configure a new Fortune Wheel step-by-step.
- [Managing Fortune Wheels](https://help.openloyalty.io/main-features/fortune-wheels/managing-fortune-wheels.md): This article describes how to view, edit, duplicate, and manually trigger Fortune Wheels.
- [Deactivating Fortune Wheels](https://help.openloyalty.io/main-features/fortune-wheels/deactivating-fortune-wheels.md)
- [How Probability Works](https://help.openloyalty.io/main-features/fortune-wheels/how-probability-works.md)
- [Implementation Checklist](https://help.openloyalty.io/main-features/fortune-wheels/implementation-checklist.md): Use this checklist to prepare, integrate, and validate your Fortune Wheel before launch.
- [Badges](https://help.openloyalty.io/main-features/badges.md): This article explains how badges can be assigned and used in your loyalty program.
- [Creating Badges](https://help.openloyalty.io/main-features/badges/creating-badges.md): Create a badge so it can be granted to members or used in campaigns.
- [Managing Badges](https://help.openloyalty.io/main-features/badges/managing-badges.md): Edit badge details, open badge pages, and deactivate unused badges.
- [Granting Badges to Members](https://help.openloyalty.io/main-features/badges/granting-badges-to-members.md): Assign a badge to a member manually and manage existing assignments.
- [Using Badges in Campaigns](https://help.openloyalty.io/main-features/badges/using-badges-in-campaigns.md): Automatically grant badges when a campaign rule matches.
- [Viewing Badges in Member Profiles](https://help.openloyalty.io/main-features/badges/viewing-badges-in-member-profiles.md): Review and manage a member’s badge assignments from their profile.
- [Custom Events](https://help.openloyalty.io/main-features/custom-events.md): In this section, you will learn about adding and managing custom events in Open Loyalty.
- [Custom Event Schemas](https://help.openloyalty.io/main-features/custom-events/custom-event-schemas.md): In this section, you will learn how to manage the custom event schemas.
- [Transactions](https://help.openloyalty.io/main-features/transactions.md): In this section, you will learn everything about Transactions. We will show you how to create Transactions, match them with customers, and many more important and helpful features.
- [Transaction List](https://help.openloyalty.io/main-features/transactions/transaction-list.md)
- [Channels](https://help.openloyalty.io/main-features/transactions/channels.md): In this section, you will learn how to set up sales channels and manage their data.
- [Transaction Details](https://help.openloyalty.io/main-features/transactions/transaction-details.md)
- [Add or Import Transactions](https://help.openloyalty.io/main-features/transactions/add-or-import-transactions.md): In this article, you will learn how to add or import transactions.
- [Matching Transactions with Members](https://help.openloyalty.io/main-features/transactions/matching-transactions.md): In this article, you will learn how transactions are matched
- [Tiers](https://help.openloyalty.io/main-features/tiers.md): In this section, you will learn all about Tiers, how to create them, and how to manage them.
- [Adding Tiers](https://help.openloyalty.io/main-features/tiers/adding-tiers.md): In this section, you will learn how to add Tiers.
- [Managing Tiers](https://help.openloyalty.io/main-features/tiers/managing-tiers.md): In this section, you will learn how to manage Tiers.
- [Tiers Configuration](https://help.openloyalty.io/main-features/tiers/tiers-configuration.md): In this section, you will learn how to configure Tiers.
- [Tier Benefits](https://help.openloyalty.io/main-features/tiers/tier-benefits.md): In this section, you will learn how to add Tier Benefits
- [Tier Analytics](https://help.openloyalty.io/main-features/tiers/tier-analytics.md): This section explains how to use and interpret Tier Analytics.
- [Tier metrics](https://help.openloyalty.io/main-features/tiers/tier-metrics.md): The numeric metrics that summarize your tier program's health.
- [Wallets](https://help.openloyalty.io/main-features/wallets.md): Learn how wallets work in Open Loyalty, how to configure wallet types, and how to manage unit transfers.
- [Wallet Types and Configuration](https://help.openloyalty.io/main-features/wallets/wallet-types-and-configuration.md): Create wallet types and configure how units behave, expire, and stay available in your program.
- [Unit Transfers](https://help.openloyalty.io/main-features/wallets/unit-transfers.md): Review wallet activity, create manual unit adjustments, and manage the lifecycle of unit transfers.
- [Unit Transfers List](https://help.openloyalty.io/main-features/wallets/unit-transfers/unit-transfers-list.md): Learn how to browse all unit transfers, use filters, and adjust the view.
- [Creating Unit Transfers](https://help.openloyalty.io/main-features/wallets/unit-transfers/creating-unit-transfers.md): Create a unit transfer in the Admin Panel to add or deduct units for a specific member.
- [Importing Unit Transfers](https://help.openloyalty.io/main-features/wallets/unit-transfers/importing-unit-transfers.md): In this article, you’ll learn how to import unit transfers into Open Loyalty.
- [Managing Unit Transfers](https://help.openloyalty.io/main-features/wallets/unit-transfers/managing-unit-transfers.md): Cancel, expire, block, and review unit transfers from the Admin Panel.
- [Achievements](https://help.openloyalty.io/main-features/achievements.md): In this section, you will learn how Achievements work in Open Loyalty, as well as how to configure them according to your preferences; how to create new Achievements, and assign them to your Campaign.
- [Creating Achievement](https://help.openloyalty.io/main-features/achievements/creating-achievement.md): In this section, you will learn how to create achievement in the Admin Panel, and what are the meanings of the elements.
- [Managing Achievements](https://help.openloyalty.io/main-features/achievements/managing-achievements.md): In this article, you will get familiar how to manage the achievements in Open Loyalty
- [Follow up Achievements](https://help.openloyalty.io/main-features/achievements/follow-up-achievements.md)
- [Rewards](https://help.openloyalty.io/main-features/rewards.md): In this section, you will get to know everything related to Rewards. You’ll be familiar with creating and managing Rewards available within your Loyalty Program.
- [Reward List](https://help.openloyalty.io/main-features/rewards/reward-list.md): In this section, you will learn how to configure and manage Rewards.
- [Rewards Configuration](https://help.openloyalty.io/main-features/rewards/reward-list/rewards-configuration.md): This section describe how to configure wallet for reward redemption
- [Creating Reward](https://help.openloyalty.io/main-features/rewards/reward-list/creating-reward.md): This section will explain you how to add reward in the Admin Panel
- [Reward Types](https://help.openloyalty.io/main-features/rewards/reward-list/reward-types.md): This section will describe what type of rewards you can set in the Admin Panel.
- [Units Conversion Coupon](https://help.openloyalty.io/main-features/rewards/reward-list/units-conversion-coupon.md): In this section you will learn how to create rewards wi a units conversion type.
- [Adding Coupons](https://help.openloyalty.io/main-features/rewards/reward-list/adding-coupons.md): This section will explain how to add coupons to Open Loyalty.
- [Reward Flow](https://help.openloyalty.io/main-features/rewards/reward-list/reward-flow.md): This section will describe the basic flow of rewards redemption depending on the business scenario (Reward Catalog or receiving Reward in the Campaign).
- [Reward Fulfillment](https://help.openloyalty.io/main-features/rewards/reward-fulfillment.md): In this section, you will learn how to browse through the list of redeemed rewards and check a single redeemed reward.
- [Canceling Redeemed Reward](https://help.openloyalty.io/main-features/rewards/reward-fulfillment/canceling-redeemed-reward.md)
- [Reward Categories](https://help.openloyalty.io/main-features/rewards/reward-categories.md): In this section, you will get to know how to set up Reward categories and how to use them in the Open Loyalty panel.
- [Webhooks](https://help.openloyalty.io/main-features/webhooks.md): Connect Open Loyalty with external systems using event-based webhook delivery.
- [How to Configure a Webhook](https://help.openloyalty.io/main-features/webhooks/configuration.md): Create and manage webhook subscriptions in the Admin Panel or via API.
- [What Triggers a Webhook](https://help.openloyalty.io/main-features/webhooks/what-triggers-a-webhook.md): In this section, you will learn about webhook trigger actions.
- [Expiring Notifications](https://help.openloyalty.io/main-features/webhooks/expiring-notifications.md): Set how many days in advance expiration-related notifications are sent.
- [HMAC](https://help.openloyalty.io/main-features/webhooks/hmac.md): Prepare for webhook request signing with Hash-based Message Authentication Code (HMAC).
- [Verifying the Signature](https://help.openloyalty.io/main-features/webhooks/hmac/verifying-the-signature.md)
- [Collections](https://help.openloyalty.io/main-features/collections.md): In this article, you will learn what Collections are, how they work, and how to use them in the Open Loyalty platform.
- [Imports / Exports](https://help.openloyalty.io/main-features/imports-exports.md)
- [Imports](https://help.openloyalty.io/main-features/imports-exports/imports.md): Learn more about available import types the best practices on the import process.
- [Data Migration Guide](https://help.openloyalty.io/main-features/imports-exports/imports/data-migration-guide.md)
- [Tips and Tricks](https://help.openloyalty.io/main-features/imports-exports/imports/tips-and-tricks.md): File encoding, formatting rules, common pitfalls, and tips for large-scale   imports in Open Loyalty.
- [Sample Import Files](https://help.openloyalty.io/main-features/imports-exports/imports/sample-import-files.md): Sample import file templates, field references, and step-by-step instructions   for every import type available in Open Loyalty.
- [Members](https://help.openloyalty.io/main-features/imports-exports/imports/sample-import-files/members.md): How to bulk import member profiles into Open Loyalty using XML files, including a sample template and field reference.
- [Member Segments](https://help.openloyalty.io/main-features/imports-exports/imports/sample-import-files/member-segments.md): How to import members into static segments using CSV files in Open Loyalty,   including prerequisites and common pitfalls.
- [Transactions](https://help.openloyalty.io/main-features/imports-exports/imports/sample-import-files/sample-import-files.md): How to import transactions and match them to members in Open Loyalty using XML or JSON files.
- [Unit Transfers](https://help.openloyalty.io/main-features/imports-exports/imports/sample-import-files/unit-transfers.md): How to add or deduct points and loyalty units in bulk using XML or JSON imports in Open Loyalty.
- [Campaign Codes](https://help.openloyalty.io/main-features/imports-exports/imports/sample-import-files/campaign-codes.md): How to import redemption codes into Open Loyalty campaigns using CSV files.
- [Reward Coupons](https://help.openloyalty.io/main-features/imports-exports/imports/sample-import-files/reward-coupons.md): How to import coupon codes into Open Loyalty rewards using CSV files.
- [Collections](https://help.openloyalty.io/main-features/imports-exports/imports/sample-import-files/collections.md): How to import collections into Open Loyalty using CSV files for use in other modules.
- [Exports](https://help.openloyalty.io/main-features/imports-exports/exports.md)
- [UI Data Exports](https://help.openloyalty.io/main-features/imports-exports/exports/ui-exports.md): Find how to export the basic data reports from the admin panel.
- [Configuration Exports](https://help.openloyalty.io/main-features/imports-exports/exports/configuration-exports.md): Find how to export the configuration of listed modules from the admin panel.
- [S3 Bucket Exports](https://help.openloyalty.io/main-features/imports-exports/exports/s3-bucket-exports.md): Here, you will learn more about S3 Bucket exports - how to use them, what data can be found there, and the best approaches to leveraging Open Loyalty export capabilities.
- [Settings](https://help.openloyalty.io/main-features/settings.md): In this section, you will learn how to manage the Open Loyalty settings.
- [Roles](https://help.openloyalty.io/main-features/settings/roles.md): Manage admin roles and permissions in the Admin Panel.
- [Available Permissions (ACL)](https://help.openloyalty.io/main-features/settings/roles/available-permissions-acl.md): Understand how the Access Control List (ACL) works in Open Loyalty and explore the available permissions that define what admins can view and modify within the system.
- [Admins](https://help.openloyalty.io/main-features/settings/admins.md): Manage admin accounts and access for your loyalty program.
- [System Logs](https://help.openloyalty.io/main-features/settings/admins/system-logs.md): In this section, you will learn how to manage and review system logs.
- [Tenants](https://help.openloyalty.io/main-features/settings/tenants.md): In this section, you will learn how to manage the tenants within your loyalty program.
- [Translations](https://help.openloyalty.io/main-features/settings/translations.md): In this section, you will learn how to manage the translations.
- [Expressions](https://help.openloyalty.io/main-features/expressions.md): In this section, you will learn about Open Loyalty language and more complex campaign conditions.
- [Attributes List](https://help.openloyalty.io/main-features/expressions/attributes-list.md)
- [Operators](https://help.openloyalty.io/main-features/expressions/operators.md)
- [Custom Functions](https://help.openloyalty.io/main-features/expressions/custom-functions.md)
- [Expression Examples](https://help.openloyalty.io/main-features/expressions/expression-examples.md)
- [Sample Use Cases](https://help.openloyalty.io/main-features/expressions/sample-use-cases.md): This section provides sample use cases that demonstrate how expressions can address your specific business scenarios.
- [Using Member Custom Attributes](https://help.openloyalty.io/main-features/expressions/sample-use-cases/using-member-custom-attributes.md)
- [Complex Effects (if, else)](https://help.openloyalty.io/main-features/expressions/sample-use-cases/complex-effects-if-else.md)
- [Excluding Members](https://help.openloyalty.io/main-features/expressions/sample-use-cases/excluding-members.md)
- [Elapsed Time Conditions](https://help.openloyalty.io/main-features/expressions/sample-use-cases/expressions.md)
- [Using Additional Dates for Calculations](https://help.openloyalty.io/main-features/expressions/sample-use-cases/additional-dates.md)
- [Set Custom Time](https://help.openloyalty.io/main-features/expressions/sample-use-cases/set-custom-time.md)
- [Register on Birthday](https://help.openloyalty.io/main-features/expressions/sample-use-cases/register-on-birthday.md)
- [Transaction on Birthday](https://help.openloyalty.io/main-features/expressions/sample-use-cases/transaction-on-birthday.md)
- [Tier Upgrade or Downgrade](https://help.openloyalty.io/main-features/expressions/sample-use-cases/tier-upgrade-or-downgrade.md)
- [Good Practices](https://help.openloyalty.io/sample-setups/good-practices.md): In this section, you will find good practices for how you can set up a campaign and increase the members' engagement by completing the challenges.
- [Pay with Points](https://help.openloyalty.io/sample-setups/pay-with-points.md): How to Pay with Points Using OpenLoyalty.
- [Promo and Discounts in Cart](https://help.openloyalty.io/sample-setups/promo-and-discounts-in-cart.md): This guide describes how to implement promo or discount calculations for items in the cart using Open Loyalty.
- [Sample Campaigns](https://help.openloyalty.io/sample-setups/sample-campaigns.md): In this section, you will find sample configurations and business scenarios for your campaigns.
- [#1 Earn 1 point for every $1 spent](https://help.openloyalty.io/sample-setups/sample-campaigns/1-earn-1-point-for-every-usd1-spent.md)
- [#2 Earn 2x points when shopping on Monday morning](https://help.openloyalty.io/sample-setups/sample-campaigns/2-earn-2x-points-when-shopping-on-monday-morning.md)
- [#3 Earn 1 stamp for every transaction](https://help.openloyalty.io/sample-setups/sample-campaigns/3-earn-1-stamp-for-every-transaction.md)
- [#4 Buy product ACME 123 and earn 100 points](https://help.openloyalty.io/sample-setups/sample-campaigns/4-buy-product-acme-123-and-earn-100-points.md)
- [#5 Refer a friend and get 100 points](https://help.openloyalty.io/sample-setups/sample-campaigns/5-refer-a-friend-and-get-100-points.md)
- [#6 Refer 5 friends and get a $50 off coupon for the next purchase](https://help.openloyalty.io/sample-setups/sample-campaigns/6-refer-5-friends-and-get-a-usd50-off-coupon-for-the-next-purchase.md)
- [#7 Register to the program and get 50 bonus points](https://help.openloyalty.io/sample-setups/sample-campaigns/7-register-to-the-program-and-get-50-bonus-points.md)
- [#8 Get 30 bonus points for your first transaction in the loyalty program](https://help.openloyalty.io/sample-setups/sample-campaigns/8-get-30-bonus-points-for-your-first-transaction-in-the-loyalty-program.md)
- [#9 Cashback campaign](https://help.openloyalty.io/sample-setups/sample-campaigns/9-cashback-campaign.md)
- [#10 Product meets selected criteria](https://help.openloyalty.io/sample-setups/sample-campaigns/10-product-meets-selected-criteria.md): In this scenario, the member needs to buy 1 product that meets the criteria: product brand (Acme), product category (Beverage), product name (Acme Drink) to get 100 points.
- [#11 Refer Shopping Friends](https://help.openloyalty.io/sample-setups/sample-campaigns/11-refer-shopping-friends.md): Reward members with points and gifts when referred friends complete their first purchase.
- [#12 Shopping Spree](https://help.openloyalty.io/sample-setups/sample-campaigns/12-shopping-spree.md): Reward members who spend €100 in May with a discount coupon and tier-qualifying units.
- [Sample Challenges](https://help.openloyalty.io/sample-setups/sample-achievements.md): In this section, you will learn practical applications of Challenges and how to use them to address your business's needs.
- [#1 Celebrate Summer - Buy 5 times between June and August](https://help.openloyalty.io/sample-setups/sample-achievements/1-celebrate-summer-configuration-buy-5-times-between-june-and-august.md)
- [#2 Frequent Buyer – Complete 10 transactions of more than €50 each](https://help.openloyalty.io/sample-setups/sample-achievements/2-place-10-orders-above-50eur-configuration-complete-10-transactions-for-more-than-50eur-each.md)
- [#3 Consistent Player - Log in to the game three times per week for eight consecutive weeks](https://help.openloyalty.io/sample-setups/sample-achievements/3-ambitious-player-configuration-log-in-to-the-game-3-times-per-week-for-8-consecutive-weeks.md)
- [#4 SKU Sell-off – Spend a total of $100 on products with SKU 'ABC132' in September](https://help.openloyalty.io/sample-setups/sample-achievements/4-sku-abc-configuration-spend-total-of-100usd-on-products-with-sku-abc132-in-september.md)
- [#5 Workout Streak – Track a workout of at least 30 minutes for five days in a row](https://help.openloyalty.io/sample-setups/sample-achievements/5-workout-configuration-track-a-workout-of-at-least-30-minutes-for-5-days-in-a-row-get-250-points.md)
- [#6 Shopping Buddies – Four referees made transactions for two consecutive weeks](https://help.openloyalty.io/sample-setups/sample-achievements/6-4-referees-made-the-transactions-for-2-consecutive-days-configuration.md)
- [#7 Referral Boost – Two referees made a transaction](https://help.openloyalty.io/sample-setups/sample-achievements/7-2-referees-made-a-transaction-configuration.md)
- [Configuration Migration](https://help.openloyalty.io/faq/configuration-migration.md)
- [Custom Attributes](https://help.openloyalty.io/faq/custom-attributes.md): This article explains what custom attributes are and how they can help you better utilize the platform and implement your loyalty program.
- [Favourite Filters](https://help.openloyalty.io/faq/favourite-filters.md)
- [GDPR](https://help.openloyalty.io/faq/gdpr.md)
- [Opt-Out](https://help.openloyalty.io/faq/opt-out.md): How to Allow Users to Opt-Out from the Loyalty Program
- [Referral Programs](https://help.openloyalty.io/faq/referral-programs.md): This article explains how to provide users with the ability to invite friends to the loyalty program by sharing a unique referral link.
- [Returns and Cancellations](https://help.openloyalty.io/faq/returns-and-cancellations.md)
- [Timezones](https://help.openloyalty.io/faq/timezones.md): Understanding how timezones work in Open Loyalty
- [Performance Tests](https://help.openloyalty.io/performance-tests.md)
- [Go-Live Preparation](https://help.openloyalty.io/go-live-preparation.md): To ensure your smooth preparation for the launch of your loyalty program, please review the go-live checklist and complete the go-live preparation form.
- [Limits Increase](https://help.openloyalty.io/limits-increase.md)
- [Helpdesk FAQ & Ticket Guide](https://help.openloyalty.io/helpdesk-faq-and-ticket-guide.md): Do you have any questions related to the new helpdesk communication? You came to the right place!

## Technical Guide

- [Introduction](https://help.openloyalty.io/technical-guide/getting-started.md): This guide was created to help you integrate with Open Loyalty API. If you have any questions, ideas, or feedback, feel free to get in touch via www.openloyalty.io.
- [Getting Started Guide](https://help.openloyalty.io/technical-guide/getting-started-guide.md)
- [Authentication](https://help.openloyalty.io/technical-guide/getting-started-guide/authentication.md): The initial step that needs to be configured is the authentication flow. See the sample example how this can be configured. Links to more detailed instructions can be found at the end of the article.
- [Member Registration Configuration](https://help.openloyalty.io/technical-guide/getting-started-guide/member-registartion-configuration.md): One of the main setup steps is choosing the registration method. See the sample example how this can be configured. Links to more detailed instructions can be found at the end of the article.
- [Add Webhook](https://help.openloyalty.io/technical-guide/getting-started-guide/add-webhook.md): See the sample example how webhooks can be configured. Links to more detailed instructions can be found at the end of the article.
- [Add & fetch a Member](https://help.openloyalty.io/technical-guide/getting-started-guide/add-member.md): See the sample example how a member can be added and fetched. Links to more detailed instructions can be found at the end of the article.
- [Create Campaign](https://help.openloyalty.io/technical-guide/getting-started-guide/create-campaign.md): Campaigns are the core of your loyalty program. See the sample example of how this can be configured. Links to more detailed instructions can be found at the end of the article.
- [Add Transaction](https://help.openloyalty.io/technical-guide/getting-started-guide/add-transaction.md): See the sample example of how a transaction can be added. Links to more detailed instructions can be found at the end of the article.
- [Add Custom Event Schema](https://help.openloyalty.io/technical-guide/getting-started-guide/add-custom-event-schema.md): See the sample example of how a custom event schema can be added. Links to more detailed instructions can be found at the end of the article.
- [Create Achievement](https://help.openloyalty.io/technical-guide/getting-started-guide/create-campaign-1.md): Achievements help with the gamification of your loyalty program. See the sample example of how this can be configured. Links to more detailed instructions can be found at the end of the article.
- [Add Custom Event](https://help.openloyalty.io/technical-guide/getting-started-guide/add-custom-event.md): See the sample example of how a custom event can be added. Links to more detailed instructions can be found at the end of the article.
- [Terms Reference](https://help.openloyalty.io/technical-guide/terms-reference.md): To assist with the easy lookup of names and IDs via the endpoints.
- [Backward Compatibility Policy](https://help.openloyalty.io/technical-guide/backward-compatibility-policy.md)
- [Upcoming Changes](https://help.openloyalty.io/technical-guide/upcoming-changes.md): This page lists API changes with a future enforcement date. Review each item and update your integration before the effective date to avoid disruptions.
- [Introduction](https://help.openloyalty.io/technical-guide/integration/introduction.md)
- [Overview of Integration Methods](https://help.openloyalty.io/technical-guide/integration/overview-of-integration-methods.md)
- [Tools and Technologies](https://help.openloyalty.io/technical-guide/integration/tools-and-technologies.md)
- [Integration Examples](https://help.openloyalty.io/technical-guide/integration/integration-examples.md)
- [Lambda](https://help.openloyalty.io/technical-guide/integration/integration-examples/lambda.md): Sample integration with Open Loyalty using serverless functions
- [Zapier](https://help.openloyalty.io/technical-guide/integration/integration-examples/zapier.md): Sample integration with the Event-Driven Architecture using Zapier
- [AWS EventBridge](https://help.openloyalty.io/technical-guide/integration/integration-examples/aws-eventbridge.md): Sample integration with the Event-Driven Architecture with multiple systems using AWS EventBridge
- [Kafka](https://help.openloyalty.io/technical-guide/integration/integration-examples/kafka.md): Sample integration with Open Loyalty using Kafka
- [Braze](https://help.openloyalty.io/technical-guide/integration/braze.md): This section outlines the partnership between Braze and Open Loyalty.
- [Open Loyalty to Braze](https://help.openloyalty.io/technical-guide/integration/braze/open-loyalty-to-braze.md): Syncing Open Loyalty Webhooks to Braze
- [Braze to Open Loyalty](https://help.openloyalty.io/technical-guide/integration/braze/braze-to-open-loyalty.md): Updating Open Loyalty Member Attributes from Braze
- [Points Updates](https://help.openloyalty.io/technical-guide/integration/braze/points-updates.md): Real-time Point Update Notifications
- [Tier Updates](https://help.openloyalty.io/technical-guide/integration/braze/tier-updates.md): Real-time Tier Update Notifications
- [Segment Updates](https://help.openloyalty.io/technical-guide/integration/braze/segment-updates.md)
- [MCP Server](https://help.openloyalty.io/technical-guide/integration/mcp-server.md): Install, configure, and use the Open Loyalty MCP Server to let AI agents manage your loyalty program via Claude, Cursor, and other MCP-compatible clients.
- [Overview](https://help.openloyalty.io/technical-guide/api-fundamentals/overview.md)
- [Environments Capabilities](https://help.openloyalty.io/technical-guide/api-fundamentals/environments-capabilities.md): Capabilities, Limitations, and Environment Differences
- [How to Query](https://help.openloyalty.io/technical-guide/api-fundamentals/how-to-query.md): The listing endpoint allows you to sort, filter, and limit the amount of data returned. Below are the guidelines for effectively utilizing these features
- [Scroll Mechanism for Pages](https://help.openloyalty.io/technical-guide/api-fundamentals/scroll-mechanism-for-pages.md)
- [Limits](https://help.openloyalty.io/technical-guide/api-fundamentals/limits.md): This article outlines the technical limits of the Open Loyalty system. Understanding these limits will help you optimize your implementation and use of the platform to ensure smooth operation.
- [Best Practices](https://help.openloyalty.io/technical-guide/api-fundamentals/best-practices.md)
- [Admin Token](https://help.openloyalty.io/technical-guide/authentication/admin-token.md): Securing your application with OpenLoyalty starts with a robust authentication flow. OpenLoyalty leverages JSON Web Tokens (JWT) to ensure that requests to its API are authorized.
- [Member Token](https://help.openloyalty.io/technical-guide/authentication/member-token.md): This article guides you through the process of authenticating members and how to manage their session tokens effectively.
- [Access Token (API Key)](https://help.openloyalty.io/technical-guide/authentication/access-token-api-key.md): This article guides you through the process of authenticating requests with the implementation of API keys known as Access Tokens.
- [Enabling SSO Login](https://help.openloyalty.io/technical-guide/authentication/enabling-sso-login.md): This guide explains how to enable Single Sign-On (SSO) login via OIDC in Open Loyalty.
- [Okta](https://help.openloyalty.io/technical-guide/authentication/enabling-sso-login/okta.md): This guide explains how to enable Single Sign-On (SSO) login via Okta in Open Loyalty.
- [Microsoft Entra ID](https://help.openloyalty.io/technical-guide/authentication/enabling-sso-login/microsoft-entra-id.md): This guide explains how to enable Single Sign-On (SSO) login via Microsoft Entra ID in Open Loyalty.
- [Enabling SSO Login via Auth0](https://help.openloyalty.io/technical-guide/authentication/enabling-sso-login-via-auth0.md): This guide explains how to enable Single Sign-On (SSO) login via Auth0 in Open Loyalty.
- [Overview](https://help.openloyalty.io/technical-guide/webhooks/overview.md)
- [Best Practices](https://help.openloyalty.io/technical-guide/webhooks/best-practices.md)
- [Sending Webhooks to AWS SQS](https://help.openloyalty.io/technical-guide/webhooks/sending-webhooks-to-aws-sqs.md)
- [Overview](https://help.openloyalty.io/technical-guide/data-exports/overview.md): Unlock the full potential of your loyalty data with automated cloud exports.
- [Set Up Integration](https://help.openloyalty.io/technical-guide/data-exports/set-up-integration.md): How to set up S3 Bucket integration for Open Loyalty data exports
- [Amazon Web Services (AWS)](https://help.openloyalty.io/technical-guide/data-exports/set-up-integration/amazon-web-services-aws.md): How to set up S3 Bucket integration for Open Loyalty data exports via AWS
- [Google Cloud Platform (GCP)](https://help.openloyalty.io/technical-guide/data-exports/set-up-integration/google-cloud-platform-gcp.md): Set up Google Cloud Storage (GCS) Integration
- [Microsoft Azure](https://help.openloyalty.io/technical-guide/data-exports/set-up-integration/microsoft-azure.md): Set up Microsoft Azure Integration
- [Data Structure and Types](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types.md): Learn more how data is organized in AWS S3 Bucket
- [Achievements](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/achievements.md)
- [Achievement Usage](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/achievement-usage.md)
- [Campaigns](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/campaigns.md)
- [Campaign Calculated Effect Results](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/campaign-calculated-effect-results.md)
- [Campaign Execution](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/campaign-execution.md)
- [Campaign Visibility](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/campaign-visibility.md)
- [Custom Events](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/custom-events.md)
- [Members](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/members.md)
- [Member Tier Changes](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/member-tier-changes.md)
- [Rewards](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/rewards.md)
- [Rewards Redemption](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/rewards-redemption.md)
- [Tiers](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/tiers.md)
- [Transactions](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/transactions.md)
- [Tenants](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/tenants.md)
- [Unit Transfers](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/unit-transfers.md)
- [Wallet Balance](https://help.openloyalty.io/technical-guide/data-exports/data-structure-and-types/wallet-balance.md)

## API Reference

- [Introduction](https://help.openloyalty.io/api-reference/introduction.md)
- [Authentication](https://help.openloyalty.io/api-reference/authentication.md)
- [Authorization](https://help.openloyalty.io/api-reference/authorization.md)
- [Achievement](https://help.openloyalty.io/api-reference/achievement.md)
- [ACL](https://help.openloyalty.io/api-reference/acl.md)
- [Admin](https://help.openloyalty.io/api-reference/admin.md)
- [Analytics](https://help.openloyalty.io/api-reference/analytics.md)
- [Audit](https://help.openloyalty.io/api-reference/audit.md)
- [Badge](https://help.openloyalty.io/api-reference/badge.md)
- [Billable Report](https://help.openloyalty.io/api-reference/billable-report.md)
- [Bulk Action](https://help.openloyalty.io/api-reference/bulk-action.md)
- [Campaign](https://help.openloyalty.io/api-reference/campaign.md)
- [Channels](https://help.openloyalty.io/api-reference/channels.md)
- [Custom Event](https://help.openloyalty.io/api-reference/custom-event.md)
- [Data Analytics](https://help.openloyalty.io/api-reference/data-analytics.md)
- [Export](https://help.openloyalty.io/api-reference/export.md)
- [Group Of Values](https://help.openloyalty.io/api-reference/group-of-values.md)
- [Health Check](https://help.openloyalty.io/api-reference/health-check.md)
- [Import](https://help.openloyalty.io/api-reference/import.md)
- [Language](https://help.openloyalty.io/api-reference/language.md)
- [Member](https://help.openloyalty.io/api-reference/member.md)
- [Custom Field Schema](https://help.openloyalty.io/api-reference/custom-field-schema.md)
- [Custom Field Group](https://help.openloyalty.io/api-reference/custom-field-group.md)
- [Custom Field Value](https://help.openloyalty.io/api-reference/custom-field-value.md)
- [Points](https://help.openloyalty.io/api-reference/points.md)
- [Reward](https://help.openloyalty.io/api-reference/reward.md)
- [Reward Category](https://help.openloyalty.io/api-reference/reward-category.md)
- [Segment](https://help.openloyalty.io/api-reference/segment.md)
- [Settings](https://help.openloyalty.io/api-reference/settings.md)
- [Store](https://help.openloyalty.io/api-reference/store.md)
- [Tier](https://help.openloyalty.io/api-reference/tier.md)
- [Transactions](https://help.openloyalty.io/api-reference/transactions.md)
- [Wallet](https://help.openloyalty.io/api-reference/wallet.md)
- [Webhook Subscription](https://help.openloyalty.io/api-reference/webhook-subscription.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://help.openloyalty.io/getting-started.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.