This guide helps you set up the Bugpilot Bug Reporting Widget to let users report bugs in just one click.

<aside> ⚠️ To build your own widget or create a custom bug reporting flow implementation, check out our Bugpilot SDK for JavaScript documentation.

</aside>

What's the Bug Reporting Widget?

Bugpilot's Bug Reporting Widget makes it easy for your users to record their screen and report bugs.

This is the default screen position and style of the Bug Reporting Widget.

This is the default screen position and style of the Bug Reporting Widget.

The typical bug reporting flow is as follows:

  1. The user clicks on the Bug Reporting Widget.
  2. A timer warns the user that a screen recording is about to happen.
  3. Once the recording starts, the user has up to 2 minutes to replicate the issue and record.
  4. At the end of the recording, users can describe what happened and what they expected. This step is optional, and the report will be saved regardless of whether the user provided a description.

That's it! 🎉 Once the report has been submitted, you can find it in the Issues page.

How to enable the Bug Reporting Widget?

<aside> ⚠️ After enabling the Widget, It can take up to 5 minutes for it to appear on your website.

</aside>

  1. Create a Bugpilot account if you haven't already.
  2. Make sure you completed the setup by adding the Bugpilot Tracking code.
  3. Navigate to Integrations.