# Get Started

{% 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.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-sidebar">:sidebar:</i><br><strong>Loyalty Console</strong></td><td><a href="https://console.wlloyalty.net/">https://console.wlloyalty.net/</a></td></tr><tr><td><i class="fa-book">:book:</i><br><strong>Loyalty Console docs</strong></td><td><a href="/pages/LojLgUBJCUMCGgU67J7L">/pages/LojLgUBJCUMCGgU67J7L</a></td></tr></tbody></table>
{% 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.&#x20;
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.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-book">:book:</i><br><strong>API documentation</strong></td><td><a href="https://docs.whitelabel-loyalty.com">https://docs.whitelabel-loyalty.com</a></td></tr><tr><td><i class="fa-key">:key:</i><br><strong>API authentication &#x26; authorization</strong></td><td><a href="/spaces/iCISqiqT495MdxVfR7JC/pages/SFhnpm1WZwVgrvbqppFk">/spaces/iCISqiqT495MdxVfR7JC/pages/SFhnpm1WZwVgrvbqppFk</a></td></tr><tr><td><i class="fa-comment">:comment:</i><br><strong>Request your credentials</strong></td><td><a href="/spaces/iCISqiqT495MdxVfR7JC/pages/ytzaTBU6s7kfHcoHLjfB">/spaces/iCISqiqT495MdxVfR7JC/pages/ytzaTBU6s7kfHcoHLjfB</a></td></tr><tr><td>Creating users</td><td><a href="/pages/P5bh67uxfoy1UxWQZHEN">/pages/P5bh67uxfoy1UxWQZHEN</a></td></tr><tr><td>Creating event types</td><td><a href="/pages/wa2SGnlOloOlxALli9X5">/pages/wa2SGnlOloOlxALli9X5</a></td></tr><tr><td>Reporting events</td><td><a href="/pages/905SXkKLHWCKTyB8Oohf">/pages/905SXkKLHWCKTyB8Oohf</a></td></tr></tbody></table>
{% 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.

<table data-column-title-hidden data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Loyalty Engine</strong></td><td>The Loyalty Engine is an advanced cloud-based platform which allows you to run engaging and dynamic loyalty programs.</td><td><a href="/files/w44VJJ42ZyFZW5O1NKg0">/files/w44VJJ42ZyFZW5O1NKg0</a></td><td><a href="/pages/HqsjZKsKxDHwasxiPbBH">/pages/HqsjZKsKxDHwasxiPbBH</a></td></tr><tr><td><strong>Events</strong></td><td>The platform works by ingesting <strong>events</strong> — such as purchases, referrals, or sign-ups — reported via API. These events are the foundation for triggering loyalty logic.</td><td><a href="/files/hbiTRdpLqbHlyCKbpTev">/files/hbiTRdpLqbHlyCKbpTev</a></td><td><a href="/pages/m4f4TnTJqKQnSPMfn6zl">/pages/m4f4TnTJqKQnSPMfn6zl</a></td></tr><tr><td><strong>Reactors</strong></td><td><strong>Reactors</strong> are rules that define how the system responds to events. Each reactor includes an event trigger, optional conditions and one or more reactions (i.e. award points, give voucher)</td><td><a href="/files/KGxGDinq4j4f1IFgqSqB">/files/KGxGDinq4j4f1IFgqSqB</a></td><td><a href="/pages/EfmC6o1HcoqoNbweR3s4">/pages/EfmC6o1HcoqoNbweR3s4</a></td></tr><tr><td><strong>Users</strong></td><td>Each user has a wallet storing their points balance, tier status, available rewards (benefits), and activity history.</td><td><a href="/files/ybfeUr8qnqXxqQz8Zx8r">/files/ybfeUr8qnqXxqQz8Zx8r</a></td><td><a href="/pages/eMqV0ASTGwZrvezfgeKd">/pages/eMqV0ASTGwZrvezfgeKd</a></td></tr><tr><td><strong>Audiences</strong></td><td>Dynamic user segments used in conditions and targeting. <strong>Audiences</strong> can be based on profile attributes, event history, points balance, tier, or purchase behaviour.</td><td><a href="/files/d9zJhfXCZUqWxisarbTH">/files/d9zJhfXCZUqWxisarbTH</a></td><td><a href="/pages/1l00jPuhzGwTrsrzLmvM">/pages/1l00jPuhzGwTrsrzLmvM</a></td></tr><tr><td><strong>Rewards</strong></td><td>Includes vouchers, offers, and digital gift cards. Rewards can be browsed, targeted, and fulfilled using the API or Loyalty Console.</td><td><a href="/files/i15CoLkfn7UdgA42ROLN">/files/i15CoLkfn7UdgA42ROLN</a></td><td><a href="/pages/1jOPZzSavnsnfdDz13UF">/pages/1jOPZzSavnsnfdDz13UF</a></td></tr><tr><td><strong>Points</strong></td><td>Configurable rules that govern point expiry, earn caps, spend caps, and balance caps.</td><td><a href="/files/OnASAxvddSA8Y9mnvXoV">/files/OnASAxvddSA8Y9mnvXoV</a></td><td><a href="/pages/KKoGLEAJKx5LYcgH7p5F">/pages/KKoGLEAJKx5LYcgH7p5F</a></td></tr><tr><td><strong>Loyalty Console</strong></td><td>Admin interface for non-developers to configure rules, create rewards, manage users, monitor activity, and test logic without needing to touch the API.</td><td><a href="/files/HfOPwuUzwG3KmA9Fpd0H">/files/HfOPwuUzwG3KmA9Fpd0H</a></td><td><a href="/pages/LojLgUBJCUMCGgU67J7L">/pages/LojLgUBJCUMCGgU67J7L</a></td></tr><tr><td><strong>API-first Platform</strong></td><td>All core functionality is available via API — suitable for embedding loyalty features into existing apps, websites, and systems.</td><td><a href="/files/LYSo3GMb7XlgNUIubERt">/files/LYSo3GMb7XlgNUIubERt</a></td><td><a href="https://docs.whitelabel-loyalty.com">https://docs.whitelabel-loyalty.com</a></td></tr></tbody></table>
{% 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.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Launch a Loyalty Program</strong></td><td>Get tips and tricks for a successful program</td><td><a href="/files/Up4lhsFGMyjRjDFVPk9w">/files/Up4lhsFGMyjRjDFVPk9w</a></td><td><a href="/pages/JTJPyFt9RwvL3RPasark">/pages/JTJPyFt9RwvL3RPasark</a></td></tr></tbody></table>
{% endstep %}
{% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://kbase.whitelabel-loyalty.com/product/get-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.