Documentation

Getting started

Create a project and collect your first response.

1. Create an account

Sign up with email, Google, or GitHub. Next, create a project so you have a public key to paste on your site.

2. Create a project

During onboarding you'll name your first project and choose which widget features to enable — feedback, bugs, ideas, chat, and reviews. Each project has its own public key and inbox. Your key looks like pk_live_….

3. Install the widget

Open Project → Embed and copy the script snippet onto any page where you want feedback. Guides for Next.js, React, WordPress, Shopify, and more are in Install the widget. Prefer an AI coding agent? Use Set up with AI.

4. Authenticate logged-in users

When someone is signed into your product, mint a signed identity JWT on your backend and pass it as data-auth-token on the embed script. Gatherly verifies the token before storing identity or opening Chats. In SPAs, call Gatherly.invalidate() after login or logout without a full reload. See User authentication and the JavaScript API.

5. Read the inbox

Messages appear under General feedback, Ideas, and Bug reports based on the type the visitor selected in the widget. Open a message to see email, username, page URL, and user agent when available.