Docs

Documentation

Integrate Feeedbackr into your app in minutes.

Portal vs API

Feeedbackr offers two ways to collect feedback:

P
Portal — A hosted page that you can redirect your users to. It provides a user-friendly interface for collecting feedback with zero setup required.
A
API — A RESTful API that allows you to integrate feedback collection directly into your application. This gives you complete control over the user experience.

Getting Started

When you register, you'll receive 50 free credits that allow you to start collecting feedback and test the app without entering a credit card.

1
Create a new application in your dashboard at:
https://feeedbackr.com/dashboard
2Select your application from the list
3Click on the Settings button to find your appId and API key
4
Choose how you want to collect feedback:
- Portal: Use our hosted feedback page (quickest setup)
- API: Integrate feedback collection directly in your app

Feedback Portal

The feedback portal is accessible at https://feeedbackr.com/send-feedback/[appId] where appId is your application's unique identifier.

Required Query Parameters

user — The unique identifier of your customer (customerId)

Optional Query Parameters

username — The display name or username of your customer

Example URL

https://feeedbackr.com/send-feedback/clrx123abc?user=customer123&username=john_doe

API

The API gives you complete flexibility to implement your own front-end interface. You can design and build the feedback collection UI that best suits your application's needs.

Endpoint

POST https://feeedbackr.com/api/feedbacks

Headers

Content-Type: application/json
x-api-key: YOUR_API_KEY

Request Body

{
  "appId": "string",     // Your application ID (CUID format)
  "content": "string",   // The feedback content
  "customerId": "string" // Unique identifier for your customer
}

Example Request

curl -X POST https://feeedbackr.com/api/feedbacks \
  -H "Content-Type: application/json" \
  -H "x-api-key: your_api_key" \
  -d '{
    "appId": "clrx123abc",
    "content": "Great application! Would love to see dark mode.",
    "customerId": "user123"
  }'

Webhook

Webhooks are optional but can be used to receive real-time notifications when new feedback is submitted. To set up a webhook, provide a URL in your application settings.

Webhook Payload

{
  "event": "feedback_created",
  "user": "string",
  "appId": "string"
}

When a new feedback is submitted, we'll send a POST request to your webhook URL with this payload. Ensure your endpoint can handle this structure and respond with a 2xx status code.

Error Codes

Error Code	Description
`APP_NOT_FOUND`	The specified application ID does not exist
`BAD_REQUEST`	The request was malformed or invalid
`FEEDBACK_LIMIT_REACH`	The user have reached the limit of feedbacks
`FEEDBACK_NOT_FOUND`	The specified feedback does not exist
`INVALID_OR_MISSING_API_KEY`	The API key is invalid or was not provided
`MISSING_ATTRIBUTES_IN_PAYLOAD`	Required fields are missing in the request body
`NO_CREDITS_LEFT`	Your account has no remaining credits
`OPENAI_NO_RESPONSE`	Failed to get a response from OpenAI service
`SERVER_ERROR`	An internal server error occurred
`UNAUTHORIZED`	You are not authorized to perform this action
`USER_NOT_FOUND`	The specified user ID does not exist