Guides

How to add a feedback widget to a Gatsby site

Where the Bopmigo line goes in a Gatsby site (gatsby-ssr.js), with code you can copy, and how to test it locally.

Short answer: add the script at the end of the body from gatsby-ssr.js with setPostBodyComponents. Build and deploy.

A changelog page with the Bopmigo Feedback window open
Requests arrive with the page they were sent from.
A resolved report in the Bopmigo inbox with its summary
Every report starts with what happened and what they expected.

Add it to Gatsby

  1. 1

    Create your Bopmigo project

    Sign up at bopmigo.com, choose Website, and add your Gatsby address. Copy your line from Install snippet:

    HTML
    <script src="https://bopmigo.com/widget.js"
      data-project="YOUR-PROJECT-ID" defer></script>
  2. 2

    Open it

    Create or open gatsby-ssr.js at the project root.

  3. 3

    Add your line

    Add the onRenderBody export above.

    React
    // gatsby-ssr.js
    import React from 'react';
    
    export const onRenderBody = ({ setPostBodyComponents }) => {
      setPostBodyComponents([
        <script
          key="bopmigo"
          src="https://bopmigo.com/widget.js"
          data-project="YOUR-PROJECT-ID"
          defer
        />,
      ]);
    };
  4. 4

    Go live

    Run gatsby build and deploy.

  5. 5

    Send yourself a test

    Open the live page, choose Feedback and send a short report. It arrives in your Bopmigo inbox (and by email, if you turned that on). Reply, then open Feedback again to see your answer.

Gatsby tips

  • gatsby develop doesn’t always reflect gatsby-ssr.js changes. Test with a production build.
  • The script is added to every page at build time.
  • Client-side navigation is picked up automatically.

Single-page apps and client-side routing

Load the script once in the root layout, not per page. Bopmigo notes the page people are on when they report, including after client-side navigation, so there’s nothing to re-run on route changes.

Testing locally

Add your local address (for example http://localhost:3000) to the project in Bopmigo, alongside your production address. Reports are only accepted from addresses you list.

What Gatsby users tend to report

  • Stale pages after content updates.
  • Images that never finish loading on mobile data.
  • Search that misses obvious results.
Three phones showing New reply on the button, the feedback list and the conversation
Replies reach people where they reported, on any screen size.

Your first week

  1. 1

    Day 1: test locally and in production

    Send a report from localhost and from your live site, and check both arrive in the same inbox.

  2. 2

    Days 2 to 5: identify signed-in users

    Pass the user ID and any useful context, such as plan or account, so each report says who it came from.

  3. 3

    Days 6 and 7: route reports to your tracker

    Copy reports that need code changes into your issue tracker, and reply when the fix ships.

Questions

Can I use the Gatsby Script component?

Yes, in a layout component. gatsby-ssr.js keeps it in one place.

Does it work on a static host?

Yes, anywhere the built site is hosted.

Why doesn’t the button show?

Check that the address you’re on is listed in your Bopmigo project, that the change is live, and open a private window in case of caching. If your site has a Content Security Policy, allow https://bopmigo.com.

More: all install guides · website options · install with a coding agent