> For the complete documentation index, see [llms.txt](https://docs.perkville.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.perkville.com/guides/onboarding.md).

# Onboarding

🎉 Welcome to Perkville! This guide will walk you through setting up your rewards program, completing your integration, and getting ready for a successful launch. Let’s get started!

## Onboarding at a glance

### Activation workflow

1. Configure the loyalty program and earning rules.
2. Configure [Business program status](https://docs.perkville.com/features/settings/business/business-program-status.md).
3. Add and configure locations.
4. Connect and enable integrations.
5. Review activation dates, transaction dates, allowed activities, and customer messages.
6. Activate or schedule the business and locations.
7. Verify the customer experience.

Before activation, confirm the business status and date, at least one configured location, each location status and schedule, integration mapping, earliest transaction dates, allowed activities, customer messages, staff permissions, and a test customer transaction.

Use [Set up and activate your business program](https://docs.perkville.com/guides/onboarding/set-up-and-activate-your-business-program.md) and [Set up and activate locations](https://docs.perkville.com/guides/onboarding/set-up-and-activate-locations.md) for the detailed workflow.

Here's the short version. The detailed steps and instructions are below, and your Perkville Customer Success Representative (CSR) will guide you through the process.

1. **Kickoff and program design:** Work with your CSR to plan how customers will earn and redeem points, and complete the program design guide.
2. **Business setup:** Configure your business information, branding, locations, staff access, and loyalty/referral rules in Perkville.
3. **Integration and testing:** Coordinate your POS or membership-system integration with your CSR and verify that the intended customer activity is recorded correctly.
4. **Prepare for launch:** Review your program setup, train staff, and prepare any customer marketing you want to use.
5. **Agree on a launch date:** Your CSR will coordinate the final setup and propose a date for your confirmation.

**Typical timing:** The existing launch guidance estimates approximately **4–8 weeks from the welcome call to launch**. Actual timing depends on the integration, decisions, and readiness of everyone involved. Your CSR will confirm the plan for your business.

For the full checklist, continue to [Steps to launch](#steps-to-launch) below.

## Launch Timeline

⏳ From Welcome call to launch = approx. 4-8 weeks

Once earning activities, rewards, and integration are finalized:

1. Your Perkville CSR will schedule your launch
2. We’ll begin automation setup
3. A tentative launch date will be proposed to you for confirmation 🚀

***

## Steps to launch

Log into your Admin Account and complete the following settings to prepare for launch:

{% stepper %}
{% step %}

### :tools: Business Settings

{% embed url="<https://vimeo.com/644517478/72153ea5ec>" %}

#### [**Business Info**](https://docs.perkville.com/features/settings/business/business-info.md)

* Business Name (required) – Appears in your program name (e.g., “\[Your Business] Rewards”)
* Business Category - Optional to add. For internal use only.
* Secondary Category - Optional to add. For internal use only.
* Support Email – Used as the reply-to address and support contact
* Support Site – Defaults to email, but you can add a link to your website’s contact page
* Website – Displayed on your program’s public-facing page

#### [**Business status**](https://docs.perkville.com/features/settings/business/business-program-status.md)

Set business status, activation timing, inactive messaging, and allowed activities.

#### [**Branding**](https://docs.perkville.com/features/branding.md)

{% embed url="<https://vimeo.com/644527505/ae99f0bb69>" %}

* Upload your logo(s), brand colors, and font (optional)
* Click Preview to customize headers, buttons, and alert boxes from the tabs
* Click Publish to update branding preferences on your program (this does not launch your program)
  {% endstep %}

{% step %}

### :page\_facing\_up: Program design guide

Your Customer Success Rep (CSR) will provide the Program Design Guide which contains a point calculator to help design how customers earn and redeem points and to determine point values for those activities based off your POS System.
{% endstep %}

{% step %}

### :sparkles: Rewards program

Use your rewards program settings page to customize how members earn and redeem points based on the work completed in the Program Design Sheets, and to add bonus earnings.

#### [**Rewards**](https://docs.perkville.com/features/redeeming-rules.md)

Add rewards customers can redeem points for (with descriptions, limits, images)

{% embed url="<https://vimeo.com/646605828/e73e420c6d>" %}

#### [**Earning**](https://docs.perkville.com/features/earning-rules.md)

Define how customers earn points (attending classes, making purchases, referrals)

{% embed url="<https://vimeo.com/646615385/61b19849ae>" %}

For the current join bonus form and membership type selector, see [Join](https://docs.perkville.com/features/earning-rules/join.md).

#### [Configuring Your Referral Program](https://docs.perkville.com/features/referrals/configuring-your-referral-program#referral-offer) 👥

Reward customers for referring their friends to your business through the program following the steps listed [here](https://docs.perkville.com/features/referrals/configuring-your-referral-program#referral-offer).

#### [**Referral Offer Setup**](https://docs.perkville.com/features/referrals/configuring-your-referral-program.md#referral-offer) 📣

To create your referral offer, go to the "Refer a Friend" earning activity on the Rewards Settings page and click the plus sign (+) to add your offer.

Additionally, you can include a link to a landing page or a coupon code on the Redemption Options settings page to make it easy for prospects to claim the offer by purchasing or booking directly through your site.

{% hint style="info" %}
This offer will be automatically emailed to prospects when a member refers them—making it a great opportunity to showcase any current intro deals or special offers.
{% endhint %}
{% endstep %}

{% step %}

### :tada: Bonus Earnings (optional)

#### [Frequency Bonus](https://docs.perkville.com/features/earning-rules/promotions-and-bonus-earnings/frequency-bonus.md)

Incentivize customers to attend more frequently each week, month, or from a selected date by offering them bonus points if they hit a certain threshold. Example: 25 bonus points when customers attend 12 or more classes each month.

#### Time Bonus

Brings customers in during certain times of day by offering them X times the points as the usual earning activity. Example: 2x/double points for classes attended at 6am Mondays through Fridays.

#### Promotion Bonus

Brings customers in during special promotions (studio anniversary, holidays, etc.) by offering them X times the points for completing an earning activity, such as class attendance, during a date range. Using the promotion bonus is a great tactic to increase enrollments and referrals by offering 2x or 3x the amount of points if customers register or refer new members during a short time period.

#### [Recurring Bonus](https://docs.perkville.com/features/earning-rules/promotions-and-bonus-earnings/recurring-bonus)

A recurring bonus works like a punch card. Customers complete the same qualifying action a set number of times, then earn a bonus. Example: Celebrate every 100 classes attended or $100 spent on retail by giving a 100 point bonus.

{% embed url="<https://vimeo.com/646634383/71fe12c497?turnstile=0.UPdIm7EdpxYp3IIvvOKwW6pV5nebgnHmlO9_wYcpdqU9F5ReEKKmN6wTH1PeDG0CVFizIvhKDiuQZzHJF0BC4NSraPo7XsIx7T6EuQ0YgISvjk5e2YVh5eM65ULHkoElCMTpF98ZyAjPMbWwqODpwilYdNcvtS_5ByzknRznF9PZhamxqdmVJ7_uo16evL8_URrGqg8VKqLfRbV8_OotmjFhljqswmvLOulKKwcj2z5bDpplQuKcao7T8y8pg3dGpWYyDuR4rVHPSb8PEigY-5RWJtMK9i56DVGJSeSCa_3cT62zimHvsrBGgUXB_qaNAGE4in2Vryxh6U1whmpR8DNKMvZNgW8NjbSj-pU_YiUAIrHyK57GSlWJvJlNt8uqBnPkWpAhkTzwis5ybAD7LBSWyMote-BKU7lkBQiyY3qnyOkSW5nUYbKfSlJb2s8aRfzrQaUxNzFHYLHc0SLIKU3Wue4Aucvgc0x58ixjNOBNpRo45-oGdBrxwNxk4NffD3Tyzk-fKU99f8RQI93bod1rzcQN6gobIC8VtkLqJbIGo_UReWvkzFeQGaqnWz57ZvJBunz2YKdKPgFQvuXAvifXZ86kQUxP3p4r_dQuEmQONZtpf6frMNznygr-q9AbVHzHPiH1NUPODyfQu5t0epMbhnQAt4kLtruXs-cMS4-sqjXmDS9JiQeg6yxYvclG7MYi7N9Xd7BmQVWef-DxtxK4LwY0i302WW-Qvbox3wgytwZfYUmCsdOhyUG9FaYVZVREFsrLSCNeOpitkr28OBdG8A4LhVzE8dY8GJUYFDPPOThDZ3ikY1cHv_5A7gNCgGDhh-D_sx3CP0eJTTSCXEiYnVHMiZEmB8Q6ggoDR250JXE8Xni6qmjfFYK2Hc_Uz4kqHvQpvaRrAXDU5OxhpSaRj7wcoJhWrxl0S4kVT6Y.CzPQZ8iHpPXv94xPYe_bCw.fd7c4db9cf92786bd7651f5b4c97077924e2750dcd595f421e74ad503c46e7a4>" %}
{% endstep %}

{% step %}

### :trophy: Challenges (optional)

Use [Challenges](https://docs.perkville.com/features/challenges.md) to boost engagement during a specific time frame. You can customize the challenges to have any number of requirements that a customer must complete.

{% embed url="<https://vimeo.com/646634383/71fe12c497>" %}
{% endstep %}

{% step %}

### 🏢 Location Setup

Add your physical/business locations in [location settings](https://docs.perkville.com/features/settings/location-setup/locations.md).

{% embed url="<https://vimeo.com/644533604/04965c0710>" %}
{% endstep %}

{% step %}

### :construction\_worker: Add Staff Members

Use the [staff member settings page](https://docs.perkville.com/features/settings/staff-members.md) to give team members access to administer the account. The main roles are:

* Admin – Full access
* Employee – Add/redeem points, run reports, mark vouchers as used. This role cannot change the program rules or its main settings.
* Front Desk – Redeem points, run reports, mark vouchers as used. This role cannot give customers points.

{% embed url="<https://vimeo.com/644547464/e65d935ab6>" %}
{% endstep %}

{% step %}

### :gear: Advanced Settings

* Welcome messages: (recommended) - The welcome message will display as text in the body of the email invitation customers receive after first completing an earning event after the program is live
* Fine print: (recommended) - The default fine print can be customized to align with your business.
* Prohibit Users from Earning or Redeeming Before Joining - Check this box to require customers to join the rewards program before they can earn or redeem points.
* Prohibit Users from Earning or Redeeming Points - Exclude people by email address from earning or redeeming points.
* Prohibit Staff from Earning or Redeeming Points - Check this box to not allow any staff members with admin privileges to earn or redeem points.
* Earning Transaction Point Limits for Employees - You can limit the number of points an EMPLOYEE level staff member can give to users in a single transaction.
* Front Desk Staff Permissions - Leave this box checked to allow a FRONT DESK level staff member to submit referrals on behalf of customers.
* IP Whitelist Ranges - Restrict access of staff members to your Business Settings to trusted IP ranges.
* Point Expiration - Expire points if customers do not earn points for selected perks in a time period.
* Integrate with Google Analytics - Option to enter your Google Analytics tracking ID for Perkville to send usage data to your Google Analytics account.
* Sales Rounding - Option to round points down or to the nearest integer for item sales that do not equal an integer. By default, points are rounded to the nearest integer.
* Referral Claim Options - Options to require:
* A phone number when a friend who was referred claims the referral offer.
* Referral claim opt in alert - When referred friends claim the referral offer, displays the message, “You agree to receive marketing messages from \[business name].”
* Referral claim lookup nearby locs - Allows referred friends to find the location nearest to them when claiming the referral offer.
* Custom Notice - Option to display a button with a message and/or linked URL on the rewards program site and within emails

{% hint style="info" %}
[Membership settings are now under **Settings → Memberships → Settings**](https://docs.perkville.com/features/settings/memberships/settings.md). Inactivity-based point expiration remains under **Settings → Advanced → Point expiration**.
{% endhint %}

{% embed url="<https://vimeo.com/645284033/ae385c6a7f>" %}
{% endstep %}

{% step %}

### 🔌 Integration

Work with your Customer Success Rep to [integrate Perkville with your POS or membership system](https://docs.perkville.com/integrations/integration-reference.md).

If you plan to use membership features, first confirm that your integration is supplying membership data. Then configure [**Settings → Memberships → Settings**](https://docs.perkville.com/features/settings/memberships/settings.md) and review the names and source systems under [**Settings → Memberships → Types**](https://docs.perkville.com/features/settings/memberships/types.md). Confirm that the data matches your program's membership requirements before enabling participation restrictions.

{% embed url="<https://docs.perkville.com/overview/integrations/integration-reference>" %}
{% endstep %}
{% endstepper %}

#### 📲 Mobile App Integrations

Perkville is a web-based platform, so members can access your loyalty program anytime using your direct program link.

Perkville currently has native app integrations with ABC Ignite and Mariana Tek. Please note that Perkville does not build or configure custom mobile app integrations.

If you have a custom or third-party mobile app, you have two options:

* **Link to your Perkville program:** Your developer can add your Perkville program URL to your app, allowing members to open your program in their device's default web browser.
* **Build a custom integration:** Your development team can create a custom integration using our [documentation](https://docs.perkville.com/overview/mobile-friendly) for a more seamless experience.

### 📣 Marketing & Promoting Program

{% hint style="success" %}
This is optional but highly recommended!
{% endhint %}

Ways to market and promote your program:

* 📧 Email/newsletter
* :mobile\_phone: Social media
* :printer: Flyer: [Editable Canva Template](https://www.canva.com/design/DAE-o63Z8lQ/OUhpNhJHxGYBFd5UkGfo3g/view?utm_content=DAE-o63Z8lQ\&utm_campaign=designshare\&utm_medium=link2\&utm_source=sharebutton)

{% stepper %}
{% step %}

### :globe\_with\_meridians: Custom Program Link

The link to your Rewards Program webpage to share with customers in your marketing can be found on the left of your admin dashboard under SHARE LINKS.

You can customize the Perkville-hosted subdomain for free, for example `yourbrand.perkville.com`. This option does not require DNS changes; contact your Perkville CSR with your desired subdomain.

Enterprise accounts can also use a custom business domain such as `rewards.yourbusiness.com`, which requires DNS configuration. See Using custom domains for your loyalty program and emails to compare the two options.
{% endstep %}

{% step %}

### :school\_satchel:Employee Training

* 📄[ Perkville Staff Training Guide](https://drive.google.com/file/d/1StIHb5cZsieQvRWhm4S1SRv02BsGp4B6/view?usp=sharing)
* :bulb: [Troubleshooting Cheat Sheet](https://docs.google.com/document/d/1FuS87hObObg1gWjOXg_mpX4xluo--qDDcOZ5PfuAEQo/edit?tab=t.0)
* 📘 [Perkville Docs](https://docs.perkville.com/)
  {% endstep %}

{% step %}

### 🚀 Launch

Work with your customer success rep to schedule your launch. Once live, customers are automatically emailed an invitation to join your business rewards program after they complete their first earning event.

[Business program status](https://docs.perkville.com/features/settings/business/business-program-status.md) — Review business status, activation dates, allowed activities, and customer messaging before starting loyalty activity.
{% 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://docs.perkville.com/guides/onboarding.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.
