Installation

Installing the code snippet

Install the capture bug reporting widget on your page by adding the following code snippet to the head section of your page:

<script>
  window.captureOptions = {
    captureKey: "YOUR_CAPTURE_KEY",
  };
</script>
<script
  src="https://cdn.capture.dev/capture-js/browser/latest.js"
  async
></script>

You should replace YOUR_CAPTURE_KEY with the correct value for your team. You can get your team's capture key by logging into the capture dashboard and visiting the "Team" page in the header.

Your capture key can be found under "Team settings".

Testing the installation

Once you've added the code snippet to your page you should test that the installation was successful by opening the widget. By default the capture widget can be triggered with a keyboard shortcut (cmd + / on mac or ctrl + / on a PC).

Visit the page on which you added the code snippet and press the key combination above. If the installation was successful, the capture widget should appear in the bottom left and you can follow the on screen instructions to create your first bug report.

If the widget does not appear, or you encounter errors, try opening your browser's developer tools to see if there are any relevant logs, and take a look at the troubleshooting page.

Configuration

Once the widget has been successfully installed, you may wish to configure it to suit your needs. Continue to the next section to find out how.