Introduction

This page gives you the quickest mental model for how Relay is structured and what you need to configure first.

Relay has two main install surfaces:

• Widget: a website chat widget.
• Embed: Shopify embedded app surfaces like changelog, feature requests, helpdesk, and announcement banners.

If you are starting from scratch, set up the app first. After that, decide whether you need the widget, the Shopify embed, or both.

Quick start

1. Go to Settings → Apps and create a workspace app.
2. Save your Shopify app credentials on that app:
   • Shopify App Client ID
   • Shopify App Client Secret
3. Click Enable Embed to generate the Relay embed token and reveal the embed snippet.
4. Go to Settings → Widgets if you also want the web widget, then create a widget and copy its install snippet.
5. Go to Settings → Partners if you want Relay to handle collaborator access requests through Shopify Partners.

What you need to fill in

In Settings → Apps, the minimum useful fields are:

• Name
• Shopify App Store URL
• Shopify App Client ID
• Shopify App Client Secret

This field is optional, but often useful:

• Shopify Partner App ID: used for Shopify Partners app history links.

What requires Shopify auth

• Widget chat: The basic install does not need Shopify auth.
• Widget helpdesk: Link the widget to an app with Shopify credentials saved.
• Embed changelog: The embed token is enough.
• Embed announcement banner: The embed token is required, and Shopify shop context is used at runtime.
• Embed feature requests: The list can load with the token, but creating, voting, and replying need Shopify idToken().

If you have not configured the app yet, continue to Setup.