> ## Documentation Index
> Fetch the complete documentation index at: https://docs.referbro.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Quick Start Guide
> Set up your first referral campaign in under 10 minutes
Follow these steps after [installing Referbro from the Shopify App Store](https://apps.shopify.com/referbro). By the end, you'll have a working referral program with WhatsApp sharing.
## Step 1: Create a Campaign
Prefer a visual walkthrough? Open the [campaign setup Scribe](https://scribehow.com/viewer/How_To_Create_A_Referral_Campaign_In_Shopify__SpKkaCjkQZaZEJDK6TO87w) alongside these steps.
In your Shopify Admin, go to **Apps → Referbro → Campaigns**, then click **Create Campaign** to open Campaign Configuration.
This is where you define the incentive structure — what discount the friend gets and what reward the referrer earns.
Configure the following fields:
| Field | What to Enter | Example |
| :----------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------ |
| **Campaign Name** | A name for your internal reference | `Summer Referral Program` |
| **Discount Strategy** | Choose **Fixed Amount** or **Percentage** | `Fixed Amount` |
| **Discount Amount** | The discount the friend receives | `150` (₹150 off) |
| **Minimum Subtotal** | Minimum cart value for the discount to apply (set `0` for no minimum) | `0` |
| **Referrer Reward** | How much the referrer earns per successful referral | `150` (or `15` for 15% discount code) |
| **Referrer Reward Type** | How the referrer is rewarded: **Cashback**, **Store Credit**, **Gift Card**, **Flat Amount Discount Code**, or **Percentage Discount Code** | `Cashback` |
| **Reward Return Period** | Days to wait after the friend's order delivery before issuing the reward | `7` |
These fields control what customers see in the referral widget on your store:
| Field | Purpose | Example |
| :---------------- | :-------------------------------------------- | :---------------------------------------------------- |
| **Share Message** | The default message when sharing via WhatsApp | `Refer a friend and get ₹150 off on your next order.` |
| **First Line** | Top line of the widget (the offer headline) | `₹150 off for your friends` |
| **Second Line** | Second line of the widget (the reward) | `₹150 in your pocket` |
| **Third Line** | Optional tagline or CTA text | *(leave blank or add a tagline)* |
Click **Save** when done.
If your shipping provider does not update Shopify's fulfillment status reliably, you can configure fallback **Delivered tag** and **RTO tag** settings under the **Advanced settings** section on the Campaign Configuration page. See [Advanced Settings](/docs/features/campaigns#advanced-settings) for details.
***
## Step 2: Configure WhatsApp
For a click-by-click walkthrough, see [How to Configure WhatsApp Templates in Referbro](https://scribehow.com/viewer/How_to_Configure_WhatsApp_Templates_in_Referbro__UZFYf1rdTy6GsTengQCjag).
Go to **Apps → Referbro → WhatsApp Settings**.
Select your WhatsApp Business API provider from the dropdown. If you use **Pragma**, select it from the list.
Enter your provider credentials:
| Field | Where to Find It |
| :------------------ | :-------------------------------------------------------------------------------------------------------- |
| **API URL** | Provided by your BSP. For Pragma, you'll find this in your Pragma dashboard settings. |
| **API Token / Key** | Your authentication key. For Pragma: go to [Pragma Dashboard → Settings](https://logisy.tech) → API Keys. |
| **Phone Number ID** | Required by some providers (e.g., Meta). For Pragma, this can be left blank. |
Don't have a WhatsApp provider yet? See the [Provider Setup Guide](/docs/features/whatsapp/providers) for detailed instructions on getting credentials for each supported provider.
Before mapping templates in Referbro, you must **first create and get them approved** on your provider's platform.
**For Pragma:**
1. Go to [logisy.tech/connect/broadcast](https://logisy.tech/connect/broadcast/).
2. Click the **Manage Template** button.
3. In the side panel, click **New Template**.
4. Fill in the template name, category, language, body text with placeholders, and any buttons.
5. Submit for approval — Meta typically approves templates within minutes to a few hours.
**For Meta (Cloud API):**
1. Go to [Meta Business Suite → WhatsApp Manager → Message Templates](https://business.facebook.com/latest/whatsapp_manager/message_templates).
2. Click **Create Template**, choose your category and language.
3. Add body text with `{{1}}`, `{{2}}` placeholders and optional URL buttons.
4. Submit for review.
Templates must be **approved by Meta** before they can be used. Do not try to map unapproved templates in Referbro — messages will fail to send.
Once your template is approved on the provider side, map it in Referbro. You'll see template slots for different triggers (e.g., Referral Invitation, Order Confirmation, etc.). For each:
* **Template ID**: The exact template name as registered with your provider (e.g., `reforder`).
* **Template Parameters**: A JSON object mapping Referbro parameters to your template's placeholders.
**Example configuration:**
```json theme={null}
{
"body.1": "Share your unique link, and your friends get ₹150 OFF, while you earn ₹150 when they buy — it's that easy! 👇",
"body.2": "https://yourstore.com?ref={{REFERRAL_CODE}}&source=order",
"languageCode": "en",
"button.url.0.1": "{{REFERRAL_CODE}}&source=order_cta"
}
```
See the [Template Reference](/docs/features/whatsapp/overview) for the full list of available placeholders and parameter formats.
***
## Step 3: Enable Store Widgets
For the Shopify theme and widget screens, follow the [Refer & Earn widget Scribe](https://scribehow.com/viewer/How_to_Configure_Refer_and_Earn_Widgets_in_Shopify__GxG4UYOETyqp12igzNa-dA).
1. Go to **Shopify Admin → Online Store → Themes → Customize**.
2. In the Theme Customizer, click the **App embeds** icon (🧩) on the left sidebar.
3. Toggle **ON** both:
* **Refer & Earn** — the floating referral button
* **Referral Received** — the discount popup for referred visitors
4. Click **Save**.
1. Go to **Shopify Admin → Settings → Checkout → Customize** (or navigate to the Checkout page in the Theme Customizer).
2. Add the **Referbro Widget** block to:
* **Order Status** page (recommended — highest conversion placement)
* **Checkout** page (optional)
3. Click **Save**.
***
## Step 4: Test Your Setup
Visit your store's homepage. You should see the **Refer & Earn** floating button. Click it, enter a phone number, and verify you receive the WhatsApp message.
Create a test order on your store. After completing the purchase, check:
* The **Order Status page** shows the Referbro widget with a referral code.
* Clicking "Share on WhatsApp" sends the correct message with the referral link.
Go to **Apps → Referbro → Analytics** to confirm events are being tracked (link generated, WhatsApp share, etc.).
See [Accessing Referral Analytics in ReferBro](https://scribehow.com/viewer/Accessing_Referral_Analytics_in_ReferBro__wCucy8wcSHWqLsmrI53Rvw?referrer=documents) for the analytics walkthrough.
**Tip:** Use the **Send Test Message** button in WhatsApp Settings to verify your provider connection without placing an order.