JavaScript SDK

import { FeedbackKit, FeedbackCategory, FeedbackSort, FeedbackStatus } from 'feedbackkit-js';

const client = new FeedbackKit({ apiKey: 'sf_your_api_key' });

// Get all feedback
const all = await client.feedback.list();

// Filter by status
const pending = await client.feedback.list({
    status: FeedbackStatus.Pending
});

// Filter by category
const bugs = await client.feedback.list({
    category: FeedbackCategory.BugReport
});

// Include merged items
const withMerged = await client.feedback.list({
    includeMerged: true,
    sort: FeedbackSort.Newest
});

// Get single feedback
const feedback = await client.feedback.get('feedback-uuid');
console.log(feedback.title, feedback.voteCount);

// Submit new feedback
const created = await client.feedback.create({
    title: 'Add dark mode',
    description: 'Please add a dark mode option for night time use.',
    category: FeedbackCategory.FeatureRequest,
    userId: 'user_12345',
    userEmail: 'user@example.com'  // optional
});

import { FeedbackKit } from 'feedbackkit-js';

const client = new FeedbackKit({ apiKey: 'sf_your_api_key' });

// Simple vote. userId is optional in 2.1.0. It is required on npm 1.0.1.
const voted = await client.votes.vote('feedback-id', {
    userId: 'user_12345'
});

// Vote with email notification opt-in. Stored only on the Team tier, and only with an email.
const notified = await client.votes.vote('feedback-id', {
    userId: 'user_12345',
    email: 'user@example.com',
    notifyStatusChange: true
});

// Remove a vote
const removed = await client.votes.unvote('feedback-id', {
    userId: 'user_12345'
});
console.log(removed.hasVoted); // false

import { FeedbackKit } from 'feedbackkit-js';

const client = new FeedbackKit({
    apiKey: 'sf_your_api_key',
    bearerToken: 'server-bearer-token'
});

// List all comments
const comments = await client.comments.list('feedback-id');
for (const comment of comments) {
    console.log(`${comment.userId}: ${comment.content}`);
    if (comment.isAdmin) console.log('(Admin response)');
}

// Add a user comment
const comment = await client.comments.create('feedback-id', {
    content: 'This would be really helpful!',
    userId: 'user_12345'
});

// Admin response. bearerToken is required. Do not ship it in a browser bundle.
const adminComment = await client.comments.create('feedback-id', {
    content: 'Thanks for the feedback! We are working on this.',
    userId: 'admin_user',
    isAdmin: true
});

import { FeedbackKit } from 'feedbackkit-js';

const client = new FeedbackKit({ apiKey: 'sf_your_api_key' });

// Register a free user. userId is required. The session id is not copied in.
const user = await client.users.register({
    userId: 'user_12345'
});

// Register a paying user with MRR
const payingUser = await client.users.register({
    userId: 'user_67890',
    mrr: 9.99
});

// Update MRR when subscription changes
const upgraded = await client.users.register({
    userId: 'user_67890',
    mrr: 19.99
});

import { FeedbackKit, SDKEvents } from 'feedbackkit-js';

const client = new FeedbackKit({ apiKey: 'sf_your_api_key' });

// Track a simple event
await client.events.track({
    eventName: 'feedback_list',
    userId: 'user_12345'
});

// Track with properties
await client.events.track({
    eventName: 'feedback_list',
    userId: 'user_12345',
    properties: {
        filter: 'feature_request',
        sort: 'votes'
    }
});

// Using predefined SDK events
await client.events.track({
    eventName: SDKEvents.FeedbackList,
    userId: 'user_12345'
});

// Track a custom event
await client.events.track({
    eventName: 'onboarding_completed',
    userId: 'user_12345',
    properties: {
        step_count: 5,
        duration_seconds: 120
    }
});