UserVoice – user feedback and helpdesk

UserVoice makes it simple for your customers to give, discuss, and vote for feedback. An unobtrusive feedback tab allows visitors to easily submit and discuss ideas without having to sign up for a new account. The best ideas are delivered to you based on customer votes.


To start using the UserVoice integration, you must have installed the django-analytical package and have added the analytical application to INSTALLED_APPS in your project file. See Installation and configuration for details.

Next you need to add the UserVoice template tag to your templates. This step is only needed if you are not using the generic analytical.* tags. If you are, skip to Configuration.

The UserVoice Javascript code is inserted into templates using a template tag. Load the uservoice template tag library and insert the uservoice tag. Because every page that you want to have the feedback tab to appear on must have the tag, it is useful to add it to your base template. Insert the tag at the bottom of the HTML body:

{% load uservoice %}
{% uservoice %}


Before you can use the UserVoice integration, you must first set the widget key.

Setting the widget key

In order to use the feedback widget, you need to configure which widget you want to show. You can find the widget keys in the Channels tab on your UserVoice Settings page. Under the Javascript Widget heading, find the Javascript embed code of the widget. The widget key is the alphanumerical string contained in the URL of the script imported by the embed code:

<script type="text/javascript">

        var uv=document.createElement('script');uv.type='text/javascript';
        var s=document.getElementsByTagName('script')[0];

(The widget key is shown as XXXXXXXXXXXXXXXXXXXX.)

The default widget

Often you will use the same widget throughout your website. The default widget key is configured by setting USERVOICE_WIDGET_KEY in the project file:


If the setting is present but empty, no widget is shown by default. This is useful if you want to set a widget using a template context variable, as the setting must be present for the generic analytical.* tags to work.

Widget options

You can set USERVOICE_WIDGET_OPTIONS to customize your widget with UserVoice’s options.


See the JS SDK Overview and the reference for the details of available options.

For example, to override the default icon style with a tab and on the left, you could define:

USERVOICE_WIDGET_OPTIONS = {"trigger_position": "left",
                            "trigger_style": "tab"}

Per-view widget

The widget configuration can be overriden in a view using uservoice_widget_options template context variable. For example:

context = RequestContext({'uservoice_widget_options': 'mode': 'satisfaction'})
return some_template.render(context)

It’s also possible to set a different widget key for a particular view with uservoice_widget_key:

context = RequestContext({'uservoice_widget_key': 'XXXXXXXXXXXXXXXXXXXX'})
return some_template.render(context)

These variable passed in the context overrides the default widget configuration.

Identifying users

If your websites identifies visitors, you can pass this information on to Uservoice. By default, the name and email of an authenticated user is passed to Uservoice automatically. See Identifying authenticated users.

You can also send the visitor identity yourself by adding either the uservoice_identity or the analytical_identity variable to the template context. (If both are set, the former takes precedence.) This should be a dictionary with the desired user traits as its keys. Check the documentation on identifying users to see valid traits. For example:

context = RequestContext({'uservoice_identity': {'email': user_email,
                                                 'name': username }})
return some_template.render(context)

If you can derive the identity from the HTTP request, you can also use a context processor that you add to the TEMPLATE_CONTEXT_PROCESSORS list in

def identify(request):
        return {'uservoice_identity': {
          email: request.user.username,
          name: request.user.get_full_name(),
          type: 'vip',
          account: {
            name: 'Acme, Co.',
            monthly_rate: 9.99,
            ltv: 1495.00,
            plan: 'Enhanced'
    except AttributeError:
        return {}

Thanks go to UserVoice for their support with the development of this application.