DocumentationREST API

Developer

One REST endpoint for custom feedback flows.

Use the same contract as the bundled SDKs to submit a note from any backend, app, or custom interface. No Cloudflare-specific protocol is required.

Endpoint

Create feedback

POST/v1/feedbackpublic · publishable key
Rate limited per project and IP
terminal
curl -X POST https://heardock.com/v1/feedback \
  -H "Authorization: Bearer hd_pub_your_key" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 8f3c-demo-unique-key" \
  -d '{
    "message": "Export freezes at 80%",
    "category": "bug",
    "context": {
      "app_version": "1.4.2",
      "platform": "ios",
      "screen": "/settings/export"
    }
  }'

Required headers

Authentication and idempotency

Authorization uses Bearer hd_pub_…. Publishable keys are safe in client code; secret keys must never appear in an app or website.

Idempotency-Key is required. Reusing the same key for a retry returns the original feedback instead of creating a duplicate.

Payload

A small, platform-neutral note

message is required and limited to 2,000 characters. Use one of bug, idea, question, or praise for category. Optional user, context, metadata, and attachments fields use the same schema as the SDKs.

Responses

Created, replayed, or rejected clearly.

A new note returns 201. An idempotent replay returns 200 with the original record.

201 Created
{
  "id": "fb_01J...",
  "status": "new",
  "created_at": "2026-11-15T12:00:00Z"
}
StatusMeaning
400 invalid_requestThe JSON body or a field is invalid.
401 invalid_keyThe publishable key is missing, invalid, or revoked.
413 payload_too_largeThe request is larger than 64 KB.
429 rate_limit / quotaA client, project, or global write budget is exhausted.