Loyalty
Docs

Search...

⌘K

Introduction

Welcome to Loyalty — the modern platform for building customer loyalty programs. This documentation will guide you through setting up, configuring, and using the Loyalty SDK to create engaging reward experiences for your users.

Getting started?

If you're new to Loyalty, we recommend starting with the Installation guide to get your environment set up, then following the Quick Start tutorial.

Features

Loyalty provides everything you need to build a world-class loyalty program.

Quick Setup

Get started in minutes with our SDK. Install, configure, and launch your loyalty program with minimal boilerplate.

Flexible Rewards

Create custom reward tiers, point multipliers, and redemption rules that match your business model.

Fully Configurable

Fine-tune every aspect of your loyalty program through a comprehensive configuration system.

Comprehensive Guides

Step-by-step guides covering common use cases from basic point systems to advanced reward strategies.

Quick Start

Follow these steps to get your loyalty program up and running.

1

Install the SDK

Add the Loyalty SDK to your project using npm, yarn, or pnpm.
2

Configure your program

Set up your loyalty program rules, point values, and reward tiers in the configuration file.
3

Integrate with your app

Use the SDK methods to award points, check balances, and redeem rewards in your application.

Architecture Overview

Loyalty is built with a modular architecture that separates concerns between point accumulation, reward management, and user tracking. The SDK communicates with the Loyalty API to handle all operations server-side, ensuring security and consistency.

Core Concepts

Understanding these core concepts will help you make the most of the Loyalty platform: Points are the fundamental unit of value, Tiers define membership levels, and Rewards are the incentives users can redeem their points for.