Get Started in 5 Minutes
This guide will get you up and running with FeedbackKit in just a few minutes. You'll have a working feedback widget integrated into your app.
Progress: 0 of 5 steps completed
Follow along and check off each step as you complete it
Create Your Account
Sign up for free and get instant access to all APIs
Get Your API Key
Generate your first API key from the dashboard
Install the Widget
Add FeedbackKit to your project with one command
Add Your First Widget
Drop in a feedback widget and customize it
Test the Integration
Try the feedback overlay and see it in action
Create Your Account
Sign up for a free FeedbackKit account to get access to all APIs and your dashboard.
Get Your API Key
Once you're logged in, navigate to the API Keys section in your dashboard to generate your first key.
feedbackkit_sk_test_••••••••••••••••••••••••••••••••Install the Widget
Install the FeedbackKit widget package in your project:
npm install @feedbackkit/widgetAdd Your First Widget
Import and use the FeedbackWidget component in your application:
import { FeedbackWidget } from '@feedbackkit/widget';
export default function MyApp() {
return (
<div>
<h1>My Website</h1>
<FeedbackWidget
apiKey="your-api-key"
appName="My App"
trigger="floating"
position="bottom-right"
onSuccess={() => {
console.log('Feedback submitted!');
}}
/>
</div>
);
}Test the Integration
Your feedback widget will appear as a floating button. Users can click it to enter feedback mode and annotate your interface.
Users can click, draw, highlight, and annotate elements on your website
🎉 Congratulations!
You've successfully integrated your first FeedbackKit widget! Here's what you can do next: