SnagRelayDocs
Project Setup

Install Code

Your API key, the install snippet, and Basic Auth for screenshots.

The Install Code tab is where every setup wizard ends, and where you'll come back to whenever you need the snippet again.

API key

A single UUID key identifies your Project to the widget. It's visible (and copyable) at the top of this tab. Treat it like a public identifier, not a secret — it only allows submitting reports to this Project, scoped by your plan's rate limits.

Script snippet

<script>
  window.onSnagRelayLoad = function (api) {
    api.init();
  };
</script>
<script
  defer
  src="https://app.snagrelay.com/widget/load/YOUR_API_KEY?onload=onSnagRelayLoad"
></script>

The widget's full configuration (appearance, form fields, capture tools, routing, AI settings) is loaded server-side from this URL — there's no separate API call needed after the script loads, and no need to update the snippet when you change settings in the dashboard.

Screenshot Authentication

If your site is behind HTTP Basic Auth (common on staging environments), screenshot capture will fail silently unless you enable this and provide the username/password SnagRelay's screenshot service should use to access the page.

WordPress plugin download

This tab also links directly to the WordPress plugin zip, for manual installs — see WordPress Plugin for the full setup flow.

Screenshot

Install Code tab with API key, script snippet, and Basic Auth fields

On this page