> For the complete documentation index, see [llms.txt](https://help.joy.so/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.joy.so/joy-with-shopify-sidekick.md).

# Joy with Shopify Sidekick

{% hint style="info" %}
Available on **all plans**. Requires **Shopify Sidekick** to be enabled on your store.
{% endhint %}

## Overview

{% embed url="<https://www.youtube.com/watch?v=VqTYMPHuvEQ>" %}

Joy now plugs directly into **Shopify Sidekick** — the AI assistant built into your Shopify admin. Ask Sidekick a question about your loyalty program in plain language and it pulls the answer straight from Joy: a customer's points, their VIP tier, which rewards they hold, how the program is driving revenue, and more.

No new tab, no digging through menus. You ask, Sidekick answers.

{% hint style="info" %}
Looking for the assistant *inside* the Joy app instead? See [Joy AI Agent](/joy-ai.md).
{% endhint %}

## What you can ask

Sidekick can read your live Joy data and answer questions across six areas:

| Area                    | Example questions                                                                                                    |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------- |
| **Health check**        | "Is my loyalty program set up correctly?" — runs a full diagnostic with a 0–100 score                                |
| **Analytics**           | "How much revenue did loyalty drive last month?" · "What's my redemption rate?" · "Show my returning-customer rate"  |
| **Customers**           | "How many points does <john@example.com> have?" · "What tier is this customer?" · "Show their recent point activity" |
| **Rewards & referrals** | "What rewards does this customer hold?" · "Who has this customer referred?" · "Show recent referral activity"        |
| **Programs**            | "List my active earning programs" · "What does my birthday program reward?" · "Show my redemption options"           |
| **VIP tiers**           | "What are my VIP tiers?" · "What's the threshold for Gold?" · "Compare revenue across tiers"                         |

## How to use it

{% stepper %}
{% step %}

### Open Sidekick

Click the **Sidekick icon** in your Shopify admin to open the assistant.
{% endstep %}

{% step %}

### Ask about your loyalty program

Type your question in plain language — mention a customer email, a program name, or a metric. Sidekick recognizes Joy and routes the question to the right place.
{% endstep %}

{% step %}

### Read the answer

Sidekick replies inline with the answer, pulled straight from your live Joy data.
{% endstep %}
{% endstepper %}

## Good to know

* **Read-only.** Sidekick answers questions about your loyalty program — it doesn't make changes. To edit anything, use the Joy app.
* **Real-time.** Customer, program, and tier answers reflect your live Joy data. Revenue and analytics figures may lag by a few minutes.
* **Setup.** Your store needs a Joy REST API key generated under **Settings → Integrations → REST API** for Sidekick to connect to Joy.

## FAQ

**Is this the same as Joy AI?**

No. [Joy AI](/joy-ai.md) lives inside the Joy app (the magic-wand panel). This brings Joy's data into **Shopify Sidekick**, so you can ask without leaving the Shopify admin.

**Can Sidekick make changes to my loyalty program?**

No. Sidekick is read-only — it answers questions about your loyalty data but doesn't change anything. To make changes, use the Joy app, or [Joy AI](/joy-ai.md) inside it.


---

# 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 dynamically by asking a question.

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

```
GET https://help.joy.so/joy-with-shopify-sidekick.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.