Submit a bug report

POST https://app.speybooks.com/api/v1/bug-reports/

Submit a bug report from the in-app reporter. Captures title, description, severity, and optionally the current page URL, browser info (viewport, theme, platform), and the last 5 API request log entries for debugging context.

The public ID is generated with collision retry (up to 5 attempts). Returns 201 with the generated public ID and initial status.

Body parameters

title string required
Short description of the symptom (5-200 characters). Displayed on the public transparency page.
min length: 5 · max length: 200
browserInfo object optional
Automatically captured browser metadata.
Show child parameters
language string optional
Browser language setting.
platform string optional
Operating system platform.
theme string optional
Active UI theme at time of report.
lightdark
userAgent string optional
Browser user agent string.
viewport object optional
description string optional
Detailed steps to reproduce, expected vs actual behaviour. Not displayed publicly.
max length: 5000
includeApiContext boolean optional
If true, attaches the last 5 API request log entries for debugging. No financial data is included.
pageUrl string optional
URL of the page where the bug was encountered.
max length: 500
severity string optional
Bug severity. Critical: data integrity risk. High: incorrect behaviour with workaround. Medium: unexpected UX. Low: cosmetic.
criticalhighmediumlow

Response

201 Bug report submitted successfully. Returns the public ID and initial status.
Show response fields
createdAt string date-time
ISO 8601 creation timestamp.
id string
Public bug report ID (e.g. bug_7k3m).
severity string
Severity level.
status string
Initial status (always "open").
title string
Report title as submitted.