Documentation

Installation

Add the BetterFeedback snippet to your application. You'll find your public key in Settings → Installation Snippet after signing in.

Step 1: Add the script tag

Place this before the closing </body> tag on every page where you want to collect feedback.

<script src="https://app.betterfeedback.io/snippet.js?key=YOUR_PUBLIC_KEY"></script>

Step 2: Initialize with user attributes (recommended)

Call BetterFeedback.init() after the snippet loads. Pass any attributes you want to use for segmentation.

<script>
  BetterFeedback.init({
    user_id: '12345',
    email: 'user@example.com',
    plan: 'pro',
    company: 'Acme Corp',
    role: 'admin'
  });
</script>

You can also pre-set attributes before the script loads:

<script>
  window.BetterFeedbackAttributes = {
    user_id: '12345',
    plan: 'pro'
  };
</script>
<script src="https://app.betterfeedback.io/snippet.js?key=YOUR_PUBLIC_KEY"></script>

Identifying users

BetterFeedback automatically generates a unique identifier for each visitor, stored in localStorage. To link survey responses to your own user records, pass a unique identifier attribute.

Unique identifier attribute

In Settings → Snippet Configuration, set the Unique identifier attribute to the key you pass in init() (e.g., user_id or email). This links the anonymous BetterFeedback identity to your user.

Custom attributes

Any key/value pairs you pass to init() are stored as custom attributes and can be used for segmentation. Common attributes:

Survey types

BetterFeedback supports four survey types, each designed for a different use case.

Display positions

Control where surveys appear in your app. Choose the position when creating a survey.

Delivery methods

Choose how your survey reaches users.

Segmentation & targeting

Target specific users with segments. A segment defines criteria that users must match (based on custom attributes). All criteria must match for a user to qualify.

Criteria operators

Segment criteria support different operators depending on the attribute type:

Scheduling

Surveys can be activated manually or scheduled to start and stop automatically.

Configuration

Fine-tune survey behavior from Settings → Snippet Configuration.

URL blocklist

Prevent surveys from showing on specific pages. Add URL patterns in Settings → Snippet Configuration.

API reference

The BetterFeedback snippet communicates with these API endpoints. Available on the Studio plan for direct integration.

Base URL: https://app.betterfeedback.io/api/v1/snippet

{
  "bf_identifier": "auto-generated-uuid",
  "external_identifier": "your-user-id",
  "custom_attributes": {
    "email": "user@example.com",
    "plan": "pro"
  }
}

{ "status": "success", "identity_id": 42 }

{
  "surveys": [
    {
      "id": 1,
      "title": "How likely are you to recommend us?",
      "description": "We'd love your feedback.",
      "survey_type": "nps",
      "follow_up_question": "What could we improve?",
      "display_position": "centered"
    }
  ]
}

{
  "survey_id": 1,
  "bf_identifier": "auto-generated-uuid",
  "rating": 9,
  "open_ended_response": "Love the simplicity!",
  "custom_attributes": { "plan": "pro" }
}

{ "status": "success", "response_id": 123 }