# 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.&#x20;

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](https://kbase.whitelabel-loyalty.com/product/loyalty-engine/loyalty-console "mention") 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="loyalty-engine/loyalty-console">loyalty-console</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://app.gitbook.com/s/iCISqiqT495MdxVfR7JC/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](https://kbase.whitelabel-loyalty.com/product/loyalty-engine/users/creating-users) 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](https://kbase.whitelabel-loyalty.com/product/loyalty-engine/events/event-types/creating-event-types) representing a behaviour or action you're planning to report to the Loyalty Engine.
4. **Report an event**\
   [Report the custom event type](https://kbase.whitelabel-loyalty.com/product/loyalty-engine/events/reporting-events) 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="https://app.gitbook.com/s/iCISqiqT495MdxVfR7JC/guides/api-authentication">API Authentication</a></td></tr><tr><td><i class="fa-comment">:comment:</i><br><strong>Request your credentials</strong></td><td><a href="https://app.gitbook.com/s/iCISqiqT495MdxVfR7JC/guides/api-authentication/request-api-credentials">Request API credentials</a></td></tr><tr><td>Creating users</td><td><a href="loyalty-engine/users/creating-users">creating-users</a></td></tr><tr><td>Creating event types</td><td><a href="loyalty-engine/events/event-types/creating-event-types">creating-event-types</a></td></tr><tr><td>Reporting events</td><td><a href="loyalty-engine/events/reporting-events">reporting-events</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="https://1999217057-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEFmrMvu6tg0ZiSX9SGEq%2Fuploads%2F6NPAMSW8q1xpZ6qMcLuy%2FFrame.png?alt=media&#x26;token=b4df8ffb-8a02-4bd9-a9b3-f2d7b9e01aae">Frame.png</a></td><td><a href="loyalty-engine/introduction">introduction</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="https://1999217057-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEFmrMvu6tg0ZiSX9SGEq%2Fuploads%2FrYZfKaGocfESSJGEM4CH%2Fschool_24dp_5F6368_FILL0_wght400_GRAD0_opsz24%203.png?alt=media&#x26;token=1ba492a5-422c-4d8f-a8e5-71a24be0176a">school_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png</a></td><td><a href="loyalty-engine/events">events</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="https://1999217057-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEFmrMvu6tg0ZiSX9SGEq%2Fuploads%2FvYtwbWfNOXVwEVG6LuNt%2Fview_sidebar_24dp_5F6368_FILL0_wght400_GRAD0_opsz24%203.png?alt=media&#x26;token=89b6b122-b6d0-4e23-ad03-83ed60b0f27a">view_sidebar_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png</a></td><td><a href="loyalty-engine/reactors">reactors</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="https://1999217057-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEFmrMvu6tg0ZiSX9SGEq%2Fuploads%2Fj2xKgG8cAjN3oG7t2BTd%2Fview_sidebar_24dp_5F6368_FILL0_wght400_GRAD0_opsz24%203.png?alt=media&#x26;token=882c615d-ca0c-464f-8172-be602e128cdc">view_sidebar_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png</a></td><td><a href="loyalty-engine/users/user-wallet">user-wallet</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="https://1999217057-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEFmrMvu6tg0ZiSX9SGEq%2Fuploads%2FfimD38DqCatIVUEdORpK%2Farchitecture_24dp_5F6368_FILL0_wght400_GRAD0_opsz24%203.png?alt=media&#x26;token=9f638a43-2e3c-4769-a620-8fe009d387df">architecture_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png</a></td><td><a href="loyalty-engine/audiences">audiences</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="https://1999217057-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEFmrMvu6tg0ZiSX9SGEq%2Fuploads%2Fqfhiy79JKev1p2gt0dQj%2Farchitecture_24dp_5F6368_FILL0_wght400_GRAD0_opsz24%203.png?alt=media&#x26;token=176f7600-dadf-412a-a346-07d9aeb41791">architecture_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png</a></td><td><a href="loyalty-engine/rewards-and-points">rewards-and-points</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="https://1999217057-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEFmrMvu6tg0ZiSX9SGEq%2Fuploads%2FIt6tc6CQhKrc7m9NGzgM%2Fcontact_support_24dp_5F6368_FILL0_wght400_GRAD0_opsz24%203.png?alt=media&#x26;token=2b38bf16-6c9b-4be7-9d7c-7a7d20ba8992">contact_support_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png</a></td><td><a href="loyalty-engine/rewards-and-points/points">points</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="https://1999217057-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEFmrMvu6tg0ZiSX9SGEq%2Fuploads%2FxtNwPAlddSXLeTVH61zB%2Fview_sidebar_24dp_5F6368_FILL0_wght400_GRAD0_opsz24%203.png?alt=media&#x26;token=4967e2f3-58dc-4702-b0a0-657721be0bb1">view_sidebar_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png</a></td><td><a href="loyalty-engine/loyalty-console">loyalty-console</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="https://1999217057-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEFmrMvu6tg0ZiSX9SGEq%2Fuploads%2FORt6IsXFWHm4es4v0ru7%2Fview_sidebar_24dp_5F6368_FILL0_wght400_GRAD0_opsz24%203.png?alt=media&#x26;token=9168ee12-1878-4dbe-9972-1770a0f6ce2b">view_sidebar_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png</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="https://1999217057-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEFmrMvu6tg0ZiSX9SGEq%2Fuploads%2FRHsC2Kg6CgOP3iNZ3HVp%2Farchitecture_24dp_5F6368_FILL0_wght400_GRAD0_opsz24%203.png?alt=media&#x26;token=9aee5072-0518-47d6-be5a-f1a867deb278">architecture_24dp_5F6368_FILL0_wght400_GRAD0_opsz24 3.png</a></td><td><a href="launch-a-loyalty-program">launch-a-loyalty-program</a></td></tr></tbody></table>
{% endstep %}
{% endstepper %}
