Embed

This page explains the base Relay embed install and how to mount only the sections you actually want to show inside your Shopify app.

Minimum requirements

• An app created in Settings → Apps
• Shopify client ID and client secret saved for that app
• Embed enabled so Relay generates an embed token

Base install

Add the Relay embed script inside your Shopify embedded app page:

<script src="https://app.superrelay.ai/embed/embed.js" data-token="YOUR_EMBED_TOKEN"></script>

You can optionally override the API base:

<script
  src="https://app.superrelay.ai/embed/embed.js"
  data-token="YOUR_EMBED_TOKEN"
  data-api="https://YOUR_API_HOST"
></script>

Mount points

Add only the containers you need:

<div id="relay-changelog"></div>
<div id="relay-announcement-banner"></div>
<div id="relay-feature-requests"></div>
<div id="relay-helpdesk"></div>

Each container enables a single Relay surface. Remove the containers you do not want to show.

Module requirements

• #relay-changelog: The embed token is enough.
• #relay-announcement-banner: The embed token is required, and Shopify shop context is used at runtime.
• #relay-feature-requests: The embed token is required. Write actions also need Shopify idToken().
• #relay-helpdesk: The embed token is required, and Shopify idToken() is needed for authenticated helpdesk actions.

If you only need one surface, keep only that container.