Joy Loyalty Devkit

Joy Loyalty Devkit

Joy Loyalty Devkit is made for developers who want to go beyond the default widget and connect directly to Joy's loyalty engine.

There are three core toolsets:

1. REST API v2

Use this to integrate Joy with any external system—mobile apps, backend services, microservices, custom flows, or third-party platforms. With the API, you can:

  • Fetch or update loyalty data (points, activities, rewards, tiers, referrals) from your own applications
  • Sync Joy events with external systems like CRM, marketing automation, or custom dashboards
  • Trigger loyalty logic from outside Shopify — mobile app events, POS extensions, or custom checkout flows
  • Build your own admin tools or internal apps powered by Joy's reward engine

In short: API = expand Joy outside the storefront.

2. JavaScript SDK

This SDK is designed specifically for storefront developers (Online Store, Headless storefronts, Hydrogen, custom front-end builds). With it, you can:

  • Render loyalty components with your own UI instead of Joy's default widget
  • Use Joy's logic (reward fetching, points calculation, referral link generation) while keeping full control over layout and styling
  • Trigger loyalty actions on the storefront using your own UX patterns
  • Build inline experiences—embedded tier badges, checkout loyalty hints, custom reward banners, etc.

In short: JS SDK = build your own loyalty UI on top of Joy.

3. MCP server

Use this to connect an AI assistant — Claude, ChatGPT, Claude Code, Cursor, Codex — to a store's live loyalty data over the Model Context Protocol (opens in a new tab). With it, you can:

  • Ask about members, points, VIP tiers, rewards, referrals and analytics in plain language
  • Investigate why an order earned no points, or whether a member is abusing referrals
  • Let the assistant award or correct points, move tiers and edit the loyalty page, with your approval
  • Build your own agents on the same tools, with a read-only key when you only need to read

In short: MCP = let an AI assistant work with Joy data.

Start with the MCP server overview.

Overview