Heresay docs

Everything you need to add a Report button to your app, read what people say, and answer them.

Set up Heresay

Each team runs its own Heresay, in its own Google account, so your reports never sit on anyone else's servers. One command sets it up:

npx create-heresay

It signs you in to Google, creates a Firebase project, links a billing account, deploys the dashboard, API and SDK, and makes you the owner. It takes about five minutes, and you can run it again if anything stops partway. Firebase's pay-as-you-go plan is needed for the API; a small app stays inside its free tier.

Later, npx create-heresay update deploys new versions and npx create-heresay status shows what's running.

Add it to an app

1. Open your dashboard at https://<your-heresay>.web.app/app/ (create-heresay prints the address) and choose Add an app. Pick the platform, give it a name, and list the websites it runs on, for example https://app.example.com and http://localhost:3000.
2. Copy the line the dashboard shows you (it has steps for Next.js, Nuxt and others too) and paste it before </body> on every page:

<script src="https://<your-heresay>.web.app/sdk/v1.js" data-key="pk_your_key" defer></script>

3. Reload your app. A Report button appears in the bottom corner. Send yourself a test report and the dashboard shows it within a few seconds.

That's the whole setup. Everything below is optional.

What your users see

A small Report button in the corner. Tapping it opens a panel with two tabs:

• Report: pick what it is (Broken, Confusing, Could be better, Idea), write a sentence, and send. The current page and app version are attached automatically.
• Your reports: everything they've sent from this device and what happened to it. When you answer, a dot appears on the button until they've seen it.

Nobody signs up. Each browser gets a random device id, which is how people see their own reports and nobody else's.

The dashboard

Reports arrive sorted by urgency: open reports first, then Broken, Confusing, Could be better and Idea, oldest first within each. For each report you can:

Open an app and choose Install to see its line again. Everyone on the Team page can read and answer reports for every app; owners can add and remove people. People sign in with Google or an email link, using the address an owner added.

Script tag options

Add any of these attributes to the script tag.

<script src="https://<your-heresay>.web.app/sdk/v1.js"
        data-key="pk_your_key"
        data-version="1.4.0"
        data-accent="#6d28d9"
        defer></script>

Look and placement

The defaults are what we recommend: change only what your app needs. The easiest way is the dashboard: open an app and choose Design to try each option on the real widget and copy the tag. The first value is the default.

Always there, whatever you choose: the Heresay mark on the button, the Your reports tab (people read why a report was declined), and Powered by Heresay in the panel and the introduction, so people can tell your app uses an outside tool. The widget lives in a shadow root, so your CSS can't restyle it.

JavaScript API

The script creates window.Heresay (also available as window.Feedback). Call these any time after it loads.

Each report also carries the page it came from: its title, its address without the query string, and the window size.

// after your user signs in
Heresay.identify({ id: user.id, label: user.name, email: user.email });

// single-page apps: name screens as the user moves
router.afterEach((to) => Heresay.setScreen(to.name));

Report types and statuses

Types, picked by the reporter

Reporters never pick a priority. It comes from the type. Confusing ranks above Could be better on purpose: a feature nobody can operate is closer to broken.

Statuses

Coding agents

Heresay can hand accepted reports to a coding agent (Claude Code, Cursor, Codex, anything with MCP or a shell). In your app's repo, run:

npx heresay connect --url https://<your-heresay>.web.app

It opens your dashboard to make a token for that repo, then adds three files you commit: .mcp.json (the Heresay MCP server), .claude/skills/heresay/SKILL.md (a short skill) and a section of AGENTS.md. The token itself stays in ~/.heresay on your computer, never in the repo. Then ask your agent:

• "Add Heresay to this app": it creates the app if needed, puts the tag in the right place for your framework, and waits for the first report.
• "Fix the next Heresay report": it picks an accepted brief, claims it, fixes it on a branch, and marks it fixed with a note the reporter reads.

What an agent can and can't do

Report text is fenced and labelled as a user's description, never instructions, in everything an agent reads, so a report can't take over your agent.

One repo, or several

Each repo gets its own token and sees only its apps. A monorepo links several apps to one token. If one app's code lives in two repos (say a web front end and an API), connect both: when you accept a report, the dashboard asks which repo the fix goes in. An agent that finds the fix belongs elsewhere hands it off, and a claimed brief shows as "In progress in …" so nobody does it twice. Claims lapse after a day without activity.

Without MCP

The same actions are commands: npx heresay briefs, brief <id>, claim <id>, note, handoff, fixed <id> "note", and guide <topic>. Agents can also read /llms.txt and the guides under /guides/ on your Heresay.

Keeping it current

The skill in your repo is small and rarely changes. The detailed steps come from your own Heresay each time, so they match what you have deployed. When a newer skill ships, the agent is told to run npx heresay connect --update, and the change shows up in git.

You can still copy a single prompt from any accepted report in the dashboard with Copy prompt for agent.

Security and limits

• Your key is public, and that's fine. It's in your page's HTML. It only identifies your project; it can't read or change anything.
• Your key only works on your site. Reports from any other website are refused. Leave the list empty when adding an app to allow any site (useful for testing). Your Heresay's own address is always allowed, so its test page works.
• Rate limits. Per device: 5 reports per 10 minutes and 20 per day. Per network: 30 per hour. Per app: 500 per day.
• Size. Reports are up to 2,000 characters. Context fields are trimmed to 200.

Privacy

Heresay stores what the user typed, the type they chose, the page or screen, your app version, browser and OS, and the user id or label only if you pass one. It sets no cookies and takes no screenshots. A random device id lives in the browser's local storage so people can see their own reports.

Content Security Policy

If your site sends a Content Security Policy, allow Heresay in two places:

script-src  https://<your-heresay>.web.app;
connect-src https://<your-heresay>.web.app;

iOS and macOS

A Swift package for SwiftUI apps (iOS 16, macOS 13 and later). In Xcode, File › Add Package Dependencies… with https://github.com/Sibhimanyu/heresay-swift, then:

import Heresay

@main struct MyApp: App {
    init() { Heresay.configure(key: "pk_your_key", url: URL(string: "https://<your-heresay>.web.app")!) }
    var body: some Scene {
        WindowGroup { ContentView().heresayReportButton() }   // iOS: a Report button in the corner
    }
}

On macOS, use ContentView().heresay() and add .commands { HeresayCommands() } for Help › Report a Problem… (⌥⌘R). The same calls as the web SDK exist: Heresay.identify(id:label:email:), Heresay.presentPreferences(), Heresay.introduce() (once per install, a welcome sheet on iOS or a small window on macOS saying where to find it; call it when the main screen appears), , Heresay.setScreen(_:), Heresay.present(type:text:), Heresay.onSent, and Heresay.send(_:text:) for your own UI. How it looks is one HeresayStyle passed to configure(…, style:), with the same choices as the web (corner, offset, text, pill or icon, size, fill, shadow, screens to hide it on, theme, typeface, English, French, Tamil or Hindi, report types, a thank-you line, sheet size, the Preferences tab). The defaults are recommended; the dashboard's Design page shows each choice and gives the Swift. The app version comes from the bundle. Native apps have no web origin to lock the key to; the rate limits still apply.

Other platforms

Android, React Native and Flutter SDKs are on the way. Until then, any app can talk to the same API. Both calls take a JSON body.

POST https://<your-heresay>.web.app/v1/reports
{ "key": "pk_…", "device_id": "a-random-id-16-to-64-chars",
  "type": "confusing", "text": "I can't find where to cancel my plan.",
  "context": { "route": "Settings", "app_version": "1.4.0", "platform": "ios", "os": "iOS 18" },
  "reporter": { "name": "Asha", "email": "asha@example.org", "note": "I use VoiceOver" } }   // optional

POST https://<your-heresay>.web.app/v1/reports/mine
{ "key": "pk_…", "device_id": "the-same-id" }   // this device's reports and their statuses

Troubleshooting