Documentation

Get started in minutes. Embed the widget, manage reports, and integrate with your tools.

Quickstart

5 min setup

Widget

Installation

API

Reference

Webhooks

Integrations

Quickstart

1. Create an account

Sign up at lilbuggr.com/signup. You'll get a default project with a public (pub_) and admin (adm_) API key.

2. Add the widget to your site

Paste this before your closing </body> tag:

<script src="https://cdn.lilbuggr.com/widget.js"
  data-key="pub_YOUR_API_KEY"></script>

3. Submit a test report

Click the floating bug button on your site, fill out the form, and submit. Check your dashboard to see the report.

4. Manage reports

Log in to the dashboard to view, filter, and update report statuses.

Widget Installation

Basic embed

<script src="https://cdn.lilbuggr.com/widget.js"
  data-key="pub_YOUR_API_KEY"
  data-theme="light"
  data-position="bottom-right"></script>

Configuration options

Attribute Default Description
data-key—Your public API key (required)
data-themelightlight or dark
data-positionbottom-rightButton position: bottom-right, bottom-left
data-color#4f46e5Accent color (hex)

API Reference

Base URL: https://api.lilbuggr.com/api/v1

Authentication

# JWT (dashboard)
Authorization: Bearer <token>

# API key (widgets)
X-API-Key: pub_<key>  # submit reports
X-API-Key: adm_<key>  # read/update reports

Submit a report

curl -X POST https://api.lilbuggr.com/api/v1/reports \
  -H "X-API-Key: pub_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Button broken", "type": "bug"}'

List reports

curl https://api.lilbuggr.com/api/v1/reports?status=open&limit=20 \
  -H "X-API-Key: adm_YOUR_KEY"

See the full API reference for all endpoints.

Webhooks

Enable webhooks in your project settings to receive POST notifications when reports are created or updated.

Payload example

{
  "event": "report.created",
  "report": {
    "id": 42,
    "title": "Login button broken",
    "type": "bug",
    "status": "open",
    "priority": "medium",
    "reporter_email": "[email protected]",
    "created_at": "2026-01-15T10:00:00+00:00"
  }
}

Events

Event Trigger
report.createdNew report submitted
report.updatedStatus or priority changed

Deliveries are retried up to 3 times with exponential backoff (60s, 120s, 240s).