RespondKit

Getting started

Install the React package and open your first support conversation.

Install the package

pnpm add @respondkit/react react react-dom tailwindcss @tailwindcss/vite

RespondKit currently expects the host application to process its stylesheet with Tailwind CSS v4.

Add the widget

Import the component and its stylesheet once in your application:

import { RespondKitWidget } from "@respondkit/react";
import "@respondkit/react/styles.css";

export function Support() {
  return (
    <RespondKitWidget
      apiBaseUrl="https://api.respondkit.dev"
      title="Support"
      context={{
        inboxId: "inbox_example",
        userId: "user_123",
        email: "customer@example.com",
      }}
    />
  );
}

Replace inbox_example with the inbox ID provisioned for your product.

Pass useful context

The widget accepts the following context when it is available:

FieldPurpose
inboxIdRoutes the conversation to the correct product and Discord forum.
userIdConnects support to your internal customer record.
emailGives the operator a stable contact identifier.
localeHelps RespondKit choose the customer language.
posthogDistinctIdLets your support tools correlate the conversation with product activity.
pathCaptures the page or screen where the user requested help.
metadataAdds JSON-safe product context specific to your application.

See React widget for the complete component surface.

On this page