DocsHTTP Submit API

HTTP Submit API

Submit feedback with POST /api/feedback from agents and server-side code.

HTTP
POST /api/feedback
Content-Type: application/json

{
  "projectId": "proj_...",
  "message": "The checkout button does nothing",
  "userEmail": "ada@example.com",
  "userName": "Ada Lovelace",
  "pageUrl": "https://example.com/checkout"
}
  • Required: projectId and message (max 5000 characters). SupaFeedback uses AI to classify submissions as an issue, idea, or other.
  • Optional: userEmail, userName (max 40 characters), pageUrl, and screen (for example 390x844). Include userEmail to email the visitor when you move the report to In progress or Done.
  • A successful submit returns { ok: true, id, notifyToken }. Unknown projectId values return 404.
  • To add an email after submitting, send POST /api/feedback/{id}/notify with { "token": notifyToken, "email": "…" }. That visitor then gets status-update emails.
  • CORS is open (Access-Control-Allow-Origin: *). Rate limits are 30 requests per minute per IP and 60 per project.
  • Screenshots are accepted only as multipart/form-data with a JSON payload field and exactly one screenshot file (PNG, JPEG, or WebP, max 3 MB). The payload must include screenshotSource set to capture or upload.
  • Over the limit, the API returns 429 with a Retry-After header in seconds.
  • Every submission gets the same AI spam check as the widget.