> For the complete documentation index, see [llms.txt](https://kbase.whitelabel-loyalty.com/product/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kbase.whitelabel-loyalty.com/product/get-started.md). # Get Started Get up and running quickly with key concepts, setup steps, and practical guidance for using the platform and integrating with the API. {% stepper %} {% step %} ### Login to the Loyalty Console The **Loyalty Console** is the admin portal for the Loyalty Engine and where you configure rules, create rewards, manage users, monitor activity, and test logic. 1. **Set a password**\ You'll receive an invite via email to set a password for your Loyalty Console account. 2. **Invite additional administrators**\ Once logged in to the Loyalty Console, you can invite additional administrators to help manage your program under Settings > Administrators in the console sidebar. 3. **Get familiar with the Loyalty Console**\ Check out the [Loyalty Console](/product/loyalty-engine/loyalty-console.md) docs for a quick overview of the console, how to manage administrators and the difference between your production and staging environments.


Loyalty Console	https://console.wlloyalty.net/
Loyalty Console docs	Loyalty Console

{% endstep %} {% step %} ### Request your API credentials If you're planning to build a custom integration with the Loyalty Engine, you'll need our API docs and most likely some administrative auth credentials to get started. 1. **Get your credentials and read the docs**\ [Request your API admin credentials](https://kbase.whitelabel-loyalty.com/developer/guides/api-authentication/request-api-credentials) if required, from WLL Support and have a skim of our API docs. 2. **Create a loyalty user**\ Review our article on [creating users](/product/loyalty-engine/users/creating-users.md) to understand how to create your first loyalty user via API. 3. **Create a custom event type**\ Create and configure your first [custom event type](/product/loyalty-engine/events/event-types/creating-event-types.md) representing a behaviour or action you're planning to report to the Loyalty Engine. 4. **Report an event**\ [Report the custom event type](/product/loyalty-engine/events/reporting-events.md) you just created against the user you created.


API documentation	https://docs.whitelabel-loyalty.com
API authentication & authorization	API Authentication
Request your credentials	Request API credentials
Creating users	Creating users
Creating event types	Creating event types
Reporting events	Reporting events

{% endstep %} {% step %} ### Get familiar with the platform The White Label Loyalty Engine is a powerful, **API-first** platform designed to be seamlessly embedded into business systems and user interfaces. It provides the flexibility and functionality needed to build **bespoke, engaging loyalty programs** tailored to your unique use case.

		Cover image
Loyalty Engine	The Loyalty Engine is an advanced cloud-based platform which allows you to run engaging and dynamic loyalty programs.	Frame.png	Introduction
Events	The platform works by ingesting events — such as purchases, referrals, or sign-ups — reported via API. These events are the foundation for triggering loyalty logic.	school_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png	Events
Campaigns	Campaigns define an earning opportunity. Rule Based campaigns use reactors to respond to events as they happen; Goal Based campaigns use missions to track progress toward a target and reward on completion.	Untitled 2.001.jpeg	Getting started with Campaigns
Users	Each user has a wallet storing their points balance, tier status, available rewards (benefits), and activity history.	view_sidebar_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png	User wallet
Audiences	Dynamic user segments used in conditions and targeting. Audiences can be based on profile attributes, event history, points balance, tier, or purchase behaviour.	architecture_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png	Audiences
Rewards	Includes vouchers, offers, and digital gift cards. Rewards can be browsed, targeted, and fulfilled using the API or Loyalty Console.	architecture_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png	Rewards & Points
Points	Configurable rules that govern point expiry, earn caps, spend caps, and balance caps.	contact_support_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png	Points
Loyalty Console	Admin interface for non-developers to configure rules, create rewards, manage users, monitor activity, and test logic without needing to touch the API.	view_sidebar_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png	Loyalty Console
API-first Platform	All core functionality is available via API — suitable for embedding loyalty features into existing apps, websites, and systems.	view_sidebar_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png	https://docs.whitelabel-loyalty.com

{% endstep %} {% step %} ### Read our guide on designing & launching a loyalty program Learn how we approach the design and delivery of a loyalty program using the Loyalty Engine. This section covers the four key pillars of a loyalty program, the four phases of implementation, and practical guidance on launching successfully. You’ll also find operational considerations and tips to help you build a scalable, effective loyalty experience.


Launch a Loyalty Program	Get tips and tricks for a successful program	architecture_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png	Launch a Loyalty Program

{% endstep %} {% endstepper %} --- # 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 that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://kbase.whitelabel-loyalty.com/product/get-started.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.