Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

UserVoice Destination


Destination Info
  • Accepts Page, Alias, Group and Identify calls.
  • Refer to it as UserVoice in the Integrations object
Connection Modes
Device-modeCloud-mode
Web Web
Mobile Mobile
Server Server

Uservoice(link takes you to an external page) 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.


Getting Started

getting-started page anchor
  1. From the Segment web app, click Catalog.
  2. Search for "UserVoice" in the Catalog, select it, and choose which of your sources to connect the destination 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. Segment automatically starts sending data from the source you selected

When you enable UserVoice from the Segment web app, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Uservoice's JavaScript onto your page.

Remember to remove UserVoice's native snippet from your page.


If you're not familiar with the Segment Specs, take a look to understand what the Identify method does. An example call would look like:

1
analytics.identify('ze8rt1u89', {
2
name: 'Zaphod Kim',
3
gender: 'Male',
4
email: 'jane.kim@example.com',
5
phone: '1-401-826-4421',
6
address: {
7
city: 'San Francisco',
8
state: 'Ca',
9
postalCode: '94107'
10
}
11
});

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, check their documentation(link takes you to an external page).


If you're not familiar with the Segment Specs, take a look to understand what the Group method does. An example call would look like:

1
analytics.group("0e8c78ea9d97a7b8185e8632", {
2
name: "Initech",
3
industry: "Technology",
4
employees: 329,
5
plan: "enterprise",
6
"total billed": 830
7
});

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, check their documentation(link takes you to an external page).


If you're not familiar with the Segment Specs, 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.


Segment lets you change these destination settings from the Segment app without having to touch any code.

Property nameTypeRequiredDescription
Accent Colorcolor

Optional

Accent Color

Default: #448dd6

Javascript API Keystring
required

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


Use the Classic Widgetboolean

Optional

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.

Default: false

Mode (Classic)select

Optional

Select Mode

Default: full

Forum ID (Classic)string

Optional

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


Widget Links Color (Classic)color

Optional

The linkColor setting defaults to "#007dbf".

Default: #007dbf

Modeselect

Optional

The mode setting defaults to "full".

Default: contact

Primary Widget Color (Classic)color

Optional

The primaryColor setting defaults to "#cc6d00".

Default: #CC6D00

Enable Screenshotsboolean

Optional

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

Default: true

Show the UserVoice Widget on Page Loadboolean

Optional

Show the UserVoice Widget on Page Load

Default: true

Enable SmartVoteboolean

Optional

Enable SmartVote

Default: true

Tab Color (Classic)color

Optional

The tabColor setting defaults to "#cc6d00".

Default: #CC6D00

Invert the Tab's Colors (Classic)boolean

Optional

The tabInverted setting defaults to false.

Default: false

Tab Label (Classic)string

Optional

The tabLabel setting defaults to "Feedback & Support".

Default: feedback

Tab Position (Classic)select

Optional

The tabPosition setting defaults to "middle-right".

Default: middle-right

Custom Ticket Fieldstext-map

Optional

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


Custom Trigger Selectorstring

Optional

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 Colorcolor

Optional

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

Default: rgba(46, 49, 51, 0.6)

Trigger Foreground Colorcolor

Optional

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

Default: #FFFFFF

Trigger Positionselect

Optional

The triggerPosition setting defaults to bottom-right

Default: bottom-right