SnagRelayDocs
Project Setup

Installation

Choose Web, WordPress, or Chrome Extension — API key, auth, and Match URLs.

The Installation tab (formerly Install Code) is where every setup wizard ends, and where you pick how this Project captures reports.

Install channels

Pick one channel. The selection is saved on the Project.

ChannelWhat you configure here
Web CodeOptional user auth, screenshot Basic Auth, project API key, embed snippet
WordPressScreenshot Basic Auth, project API key; site visibility lives in the plugin
Chrome ExtensionMatch URLs + how each person connects from the extension

Switching to Chrome Extension enables extension injection and turns off the embed path for this Project. Switching away disables extension injection.

Project API key

A UUID that identifies this Project to Web / WordPress / SDKs. Visible on the Installation tab. Treat it like a public identifier, not a secret — it only allows submitting reports to this Project, scoped by plan rate limits.

Extension installs do not use this key in the browser extension — owners Sign in as owner, invited people Authenticate Chrome from their access email.

Require authenticated users

(Web Code channel only.)

When enabled, the embed stays hidden until a person unlocks the site in their browser:

  1. Invite them from Team and set a Website origin (e.g. https://example.com) — unlock applies to the whole host.
  2. They open Your accessUnlock on this Project.
  3. They’re sent back to the site; the widget unlocks for that browser session.

This is separate from Chrome extension connect.

Screenshot authentication

If the site is behind HTTP Basic Auth (common on staging), enable this and provide credentials so SnagRelay’s screenshot service can reach the page.

Web embed snippet

<script>
  window.onSnagRelayLoad = function (api) {
    api.init();
  };
  var script = document.createElement('script');
  script.defer = 1;
  script.src = 'https://app.snagrelay.com/widget/load/YOUR_API_KEY?onload=onSnagRelayLoad';
  document.getElementsByTagName('head')[0].appendChild(script);
</script>

Paste before the closing </head> (or as shown in the dashboard). Appearance, form fields, and capture tools are loaded from the server — you don’t need to change the snippet when you update Project settings.

WordPress

Install from the WordPress directory, connect with this Project’s API key. API key and widget visibility are managed on the plugin settings page in WordPress. See WordPress Plugin.

On this page