Web SDK

Our Web SDK is an easy way for anyone to report bugs without installing any extra extensions or signing up. It has everything developers need to integrate this reporting system with their websites - documentation on how to use it and code samples for quick customization. Install the Web SDK, and start receiving professional, data-rich bug reports from anyone - even your customers.

How it works

Easy, quick, and effortless to install — with a few lines of code, our Web SDK enables your software developers to always receive professional, data-rich bug reports from anyone, including your customers.

You can get started with our SDK Documentation. Follow the instructions to copy and paste the single code snippet, inject it to your app, and a report bug button or widget will be added to your app.

How to enable

You have full control to manage which domains or page SDK will be enabled on. Here’s how to install our Web SDK to your internal or production apps:

  1. Generate a Public App ID in workspace's settings. Whitelist domains on which the SDK will be integrated. Select upload collection and permission.
  2. From the SDK documentation, copy-paste the snippet  into your page's <body>  and follow instruction to integrate a bug report button into your site
  3. On your site, click report bug button to start recording
  4. Finish the recording, input title and description, then click Submit
  5. The bug report will be uploaded to your Bird workspace
  6. A copy link is also provided for anyone with the link can view this bug report

Customization

The Web SDK comes pre-configured with default screens, allowing it to be used without any further customization. To optimize your SDK, Bird also offers the ability to customize options, such as:

  • Set dark or light theme for the default screen
  • Set position of the default button or widget
  • Customize UI text 
  • Add additional triggers
  • Disable the default button
  • Define which fields users need to submit
  • Pre-fill / auto-include the user email
  • Hide the session link from the user
  • Skip the introduction screen
  • Exclude recording of select data types
  • Mutate recorded data before upload

You can find detailed instructions here.

Limitations

While the lightweight aspects of the technology has made SDK possible, it does come with some limitations:

  • Screen recordings recorded by SDK will be in the DOM recording format rather than in video format.
  • Therefore, screen recordings may appear different, or have missing sections, depending on the contents of the page:
  • Some embed elements like <iframe> and <canvas> are not recorded (e.g. Google Maps), and neither anything outside the HTML document like native MacOS/Windows menus.
  • Only content on the specific page is recorded, data in popups or other tabs are not recorded.
  • The technology works by recording "events". On pages that trigger a high volume of events in a short period of time (e.g. a page loading a lot of data in the background) that could cause stability issues.

Put your knowledge to practice

Try Bird on your next bug - you’ll love it

Try Bird later, from your desktop

Bird Call to action parrot
By clicking “Accept”, you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. View our Privacy Policy for more information.