UserVoice Destination

Uservoice is a customer support and feedback tool that lets your users submit feedback right from your site, and helps you manage all the incoming requests.

This document was last updated on November 8th, 2018. If you notice any gaps, out-dated information or simply want to leave some feedback to help us improve our documentation, please let us know!

Getting Started

The first step is to make sure UserVoice supports the source type and connection mode you’ve chosen to implement. You can learn more about what dictates the connection modes we support here.

WebMobileServer
📱 Device-based
☁️ Cloud-based
  1. From your Segment UI’s Destinations page click on “Add Destination”.
  2. Search for “UserVoice” within the Destinations Catalog and confirm the Source you’d like to connect to.
  3. Add your Javascript API Key (Your API Key appears in the javascript snippet URL as widget.uservoice.com/APIKEY.js.) and enable the destination in Segment.
  4. We’ll automatically start recording data.

When UserVoice is enabled in Segment, our CDN will update within 5-10 minutes, and Uservoice’s javascript is asynchronously loaded onto your page. Please remember to remove UserVoice’s snippet from your page.

Identify

If you haven’t had a chance to review our spec, please take a look to understand what the Identify method does. An example call would look like:

analytics.identify('ze8rt1u89', {
  name: 'Zaphod Beeblebrox',
  gender: 'Male',
  email: 'Zaphod@hotmail.com',
  phone: '1-401-826-4421',
  address: {
    city: 'San Francisco',
    state: 'Ca',
    postalCode: '94107'
  }
});

When you call identify the userId and traits included in the call will be set to the current user in UserVoice. For more details on identifying users on UserVoice, please check their documentation.

Group

If you haven’t had a chance to review our spec, please take a look to understand what the Group method does. An example call would look like:

analytics.group("0e8c78ea9d97a7b8185e8632", {
  name: "Initech", 
  industry: "Technology",
  employees: 329, 
  plan: "enterprise", 
  "total billed": 830
});

When you call group the traits included in the call will be set to the current user’s Account in UserVoice. For more details on grouping users on UserVoice, please check their documentation.

Alias

If you haven’t had a chance to review our spec, please take a look to understand what the Alias method does. An example call would look like:

analytics.alias("507f191e81");

For your implementation, make sure to replace “507f191e81” with your user’s previous ID.

Calling alias connects anonymous visitors to identified users.


Supported Sources and Connection Modes

WebMobileServer
📱 Device-based
☁️ Cloud-based

To learn more about about Connection Modes and what dictates which we support, see here.

Settings

Segment lets you change these destination settings via your Segment dashboard without having to touch any code.

Accent Color

Accent Color

Javascript API Key

Your API Key appears in the javascript snippet URL as widget.uservoice.com/APIKEY.js. This setting is required.

Use the Classic Widget

If you want to use the classic version of the UserVoice widget make sure to enable this setting, and customize it using the any of the classic options below.

Mode (Classic)

Select Mode

Forum ID (Classic)

Your Forum ID appears in the JavaScript code snippet as forum_id: YOUR_FORUM_ID.

The linkColor setting defaults to “#007dbf”.

Mode

The mode setting defaults to “full”.

Primary Widget Color (Classic)

The primaryColor setting defaults to “#cc6d00”.

Enable Screenshots

This will allow users to submit a screenshot of the current window when submitting a message with the contact form.

Show the UserVoice Widget on Page Load

Show the UserVoice Widget on Page Load

Enable SmartVote

Enable SmartVote

Tab Color (Classic)

The tabColor setting defaults to “#cc6d00”.

Invert the Tab's Colors (Classic)

The tabInverted setting defaults to false.

Tab Label (Classic)

The tabLabel setting defaults to “Feedback & Support”.

Tab Position (Classic)

The tabPosition setting defaults to “middle-right”.

Custom Ticket Fields

This will allow you to set field value pairs for ticket custom fields (set via your admin console).

Custom Trigger Selector

If you want to have your own custom UserVoice trigger, add the CSS selector for the trigger here. It might look like: #uservoice-trigger.

Trigger Background Color

This will change the background color of the trigger. It defaults to a translucent gray.

Trigger Foreground Color

This will change the color of the text on the trigger, including the question mark.

Trigger Position

The triggerPosition setting defaults to bottom-right



Questions? Need help? Contact us!
Can we improve this doc?
Email us: docs-feedback@segment.com!