SnagRelayDocs
Installation

Web Widget

Add SnagRelay to any website with one script tag.

The web widget is a floating button that any visitor can click to report a bug. It loads asynchronously and has no measurable impact on page speed.

Install

Get your API key from the Install Code tab of your Project (see Install Code), then add this before the closing </body> tag:

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

That's it. Position, colors, button text, capture tools, and form fields are all configured from the dashboard's Project Setup tabs — you don't need to touch the snippet again after installing it.

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

Authenticated pages (Basic Auth)

If your site (or staging environment) sits behind HTTP Basic Authentication, screenshots will fail to render unless you enable Screenshot Authentication on the Install Code tab and provide the credentials.

Higher-fidelity screenshots

Installing the companion Chrome Extension improves screenshot capture (e.g. across browser chrome, some cross-origin iframes) for visitors using Chrome, Edge, or Brave. Everyone else falls back to the widget's built-in DOM capture automatically.

On this page