> For the complete documentation index, see [llms.txt](https://help.openloyalty.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.openloyalty.io/playbook/introduction/how-the-playbook-works.md).

# How the Playbook works

What you'll find in each section of the Playbook and how to read and reuse a sample setup.

The Playbook is organised by what you want to achieve, not by admin-panel module. Use it alongside the [User Guide](https://help.openloyalty.io/): the Playbook tells you which features to combine for a goal, and the User Guide shows each screen step by step.

***

## 📚 What's in the Playbook

| Section           | What it gives you                                                                     | Use it when                                                        |
| ----------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| **Introduction**  | The concepts, prerequisites and good practices behind every setup.                    | You're new to Open Loyalty or planning your first campaigns.       |
| **Sample Setups** | Ready configurations for campaigns, challenges, product analytics and checkout flows. | You have a goal and want a proven way to reach it.                 |
| **FAQ**           | Answers to recurring configuration and compliance questions.                          | You hit a specific question while building or running the program. |

***

## 🧩 How to read a sample setup

Most sample setups follow the same structure:

* **Business goals** – the metrics the setup is meant to move, such as number of transactions, transaction value or referrals.
* **Loyalty mechanism** – the mechanic it relies on, such as a currency, stamps, tiers or a referral.
* **Description** – when the setup works well and for which industries.
* **Default configuration** – the campaign type, trigger, conditions and effects, named as they appear in the Admin Panel.
* **Actionable tips** – ways to limit costs, prevent fraud or adapt the setup.
* **JSON file** – where available, a configuration file you can import instead of building the campaign by hand.

Product Analytics setups are written as scenarios instead: a situation a loyalty team faces, followed by the steps to handle it.

***

## 🛠️ How to use a setup

{% stepper %}
{% step %}

### Pick a setup by goal

Start from the business goal you want to move, not from the feature. Each sample section opens with a list of setups and the goals they serve.
{% endstep %}

{% step %}

### Check the prerequisites

Make sure the wallets, segments, tiers, rewards or custom event schemas the setup refers to exist in your tenant. See [Before you start](https://help.openloyalty.io/playbook/introduction/before-you-start.md).
{% endstep %}

{% step %}

### Build or import it

Configure the setup in the Admin Panel, or import its JSON file from **Campaigns › Direct** with **Add campaign › Import campaigns**. Then adjust the values (points, thresholds, dates, limits) to your program.
{% endstep %}

{% step %}

### Test before you launch

Run the setup through the [Campaign simulator](https://help.openloyalty.io/campaigns/campaigns/campaign-simulation) to check which campaigns apply and what they award.
{% endstep %}

{% step %}

### Launch and measure

Activate the setup, then review its results against the goal you set. See [Good Practices](https://help.openloyalty.io/playbook/introduction/good-practices.md).
{% endstep %}
{% endstepper %}

{% hint style="info" %}
The values in each setup (points, amounts, dates) are examples. Change them to match your budget, currency and program rules.
{% endhint %}


---

# 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://help.openloyalty.io/playbook/introduction/how-the-playbook-works.md?ask=<question>&goal=<user_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.
