Setup

This page walks you through the minimum Relay setup in the same order most teams actually use it.

1. Create the app

Go to Settings → Apps and create a new app record for the Shopify app you want Relay to support.

At minimum, fill in:

• Name
• Shopify App Store URL

You can also add:

• Shopify Partner App ID

Use one Relay app record per Shopify app.

2. Enable the embed

Open the app you just created. In the Shopify Integration section:

1. Paste Shopify App Client ID.
2. Paste Shopify App Client Secret.
3. Click Enable Embed.

This does two important things:

• It saves the Shopify credentials Relay uses to verify Shopify ID tokens.
• It generates the Relay embed token.

After that, Relay shows the embed snippet. Use that snippet as your source of truth instead of rebuilding it by hand.

3. Create a widget if you need one

Go to Settings → Widgets and create a widget if you want the Relay website widget.

The minimum useful fields are:

• Name
• Website URL, if you want the destination site tracked in the UI

Common optional settings:

• Link the widget to the app you created.
• Turn on Knowledge Base.
• Turn on Helpdesk.

Linking the widget to an app is the safest default whenever the widget should use app-specific helpdesk behavior or Shopify-authenticated flows.

4. Connect Shopify Partners if you need collaborator access

Go to Settings → Partners only if you want Relay to request collaborator access through Shopify Partners.

At minimum, provide:

• Partner Organization ID
• the app selection for the partner account

Only add the Shopify Partners session token if you want Relay to request collaborator access on your behalf.

Read Collaborator Access for the exact cookie path.

Setup checklist

• The app is created in Settings → Apps.
• The Shopify client ID is saved.
• The Shopify client secret is saved.
• The embed token has been generated.
• The widget is created, if you need one.
• The partner account is connected, if you need collaborator access.