Widget

The Convas widget allows you to collect feedback from customers directly within your application, without redirecting them to a separate feedback page. This creates a seamless experience that encourages more feedback submissions.

Prerequisites

Before installing the widget, make sure you have:

Custom domain configured - Required for the widget to work properly

How the Widget Works

The widget adds a floating feedback button to your website that opens a feedback form when clicked. Customers can:

Submit new feature requests and bug reports
Browse and vote on existing feedback
View your public roadmap
All without leaving your application

For an even better experience, combine the widget with auto-login to automatically authenticate your users.

Setup for Web Applications

Important: Using a custom domain for Convas is required to use the widget. The widget can only be used on that domain - using it on any other domain will result in authentication errors. This is due to browser security updates related to cross-domain cookies.

For example, with the custom domain feedback.example.com, you can use the widget on example.com including all subdomains.

Installation

To install the widget, copy and paste the code snippet below before the </body> tag on every page where you want the widget to appear.

Important: Replace feedback.example.com with your actual custom domain configured in Convas settings.

<script>
(function(w, d, s, o, f, js, fjs) { w[o] = w[o] || function() { (w[o].q = w[o].q || []).push(arguments); }; (js = d.createElement(s)), (fjs = d.getElementsByTagName(s)[0]); js.id = o; js.src = f; js.async = 1; fjs.parentNode.insertBefore(js, fjs); })(window, document, 'script', '_convas_sdk', 'https://convas.io/static/convas-sdk.js'); 
window._convas_sdk('init', {
  customDomain: 'feedback.example.com',
  widget: {
    enabled: true,
    showLauncher: true
  }
});
</script>

That's it! The Convas widget should now appear on your page with a floating feedback button.

Customization Options

Custom Widget Color

To match your brand, you can customize the color of the widget launcher icon. Just update the primaryColor property in the init method of the widget script.

window._convas_sdk("init", {
  customDomain: "feedback.example.com",
  widget: {
    enabled: true,
    showLauncher: true,
    primaryColor: "#bd34c8" // Your brand color
  }
});

Widget Configuration Options

enabled: Enable/disable the widget
showLauncher: Show/hide the floating button
primaryColor: Custom color for the widget button

Enhanced User Experience

For the best user experience, consider adding auto-login to your widget setup. This will:

Automatically identify your authenticated users
Pre-populate user information in feedback forms
Enable advanced user segmentation
Remove the need for separate account creation

Mobile Apps

Android Support

Widget support for Android is currently in development. If this is important for your use case, please contact our support team to be notified when it becomes available.

iOS Support

Widget support for iOS is currently in development. If this is important for your use case, please contact our support team to be notified when it becomes available.

Documentation