Skip to main content

Website Widget

The Kapa Website Widget is a powerful tool that can be seamlessly integrated into any website or documentation platform. It enables users to ask natural language questions about your product, significantly enhancing user experience by providing quick and accurate answers. The widget is highly customizable, allowing you to tailor its appearance to match your brand identity. To experience it firsthand, try our "Ask AI" widget in the bottom right corner of this page.

Website Widget

Example Deployments

Explore our showcase to see how companies like CircleCI, Prisma, and Mapbox have styled and implemented the Kapa widget to enhance their developer experience.

Getting Started​

Setting up the Kapa Website Widget involves these main steps:

  1. Create a new integration: Visit the /Integrations tab on app.kapa.ai to create a new website widget integration, enable your domain, and copy its integration/website ID.

  2. Installation: Learn how to add the Kapa widget script to your webpage, with detailed instructions for various platforms.

  3. Configuration: Explore the mandatory parameters and optional styling choices to customize your widget.

For more detailed guidance, check out our tutorials on best practices for widget deployment and styling the widget like a customer help chat, which provide step-by-step instructions for common use cases and best practices.

Advanced Features​

Once you've set up your widget, you can explore these advanced features:

  • User Tracking: Implement user tracking to gain valuable insights into how your users interact with the widget.

  • Events API: Leverage the Events API to monitor widget interactions and integrate with your analytics tools.

These features can help you further optimize your widget's performance and gather important user data.