UserVoice Destination
Destination Info
- Accepts Page, Alias, Group, and Identify calls
- Refer to it as UserVoice in the Integrations object
Components
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.
Getting Started
- From the Segment web app, click Catalog.
- Search for “UserVoice” in the Catalog, select it, and choose which of your sources to connect the destination to.
- 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.
- 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.
Identify
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:
analytics.identify('ze8rt1u89', {
name: 'Zaphod Kim',
gender: 'Male',
email: 'jane.kim@example.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, check their documentation.
Group
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:
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, check their documentation.
Alias
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.
Settings
Segment lets you change these destination settings from the Segment app without having to touch any code.
Setting | Description |
---|---|
Accent Color | color , defaults to #448dd6. Accent Color |
Javascript API Key (required) |
string . Your API Key appears in the javascript snippet URL as widget.uservoice.com/APIKEY.js. This setting is required. |
Use the Classic Widget | boolean , defaults to FALSE . 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 , defaults to full. Select Mode |
Forum ID (Classic) | string . Your Forum ID appears in the JavaScript code snippet as forum_id: YOUR_FORUM_ID . |
Widget Links Color (Classic) | color , defaults to #007dbf. The linkColor setting defaults to “#007dbf”. |
Mode | select , defaults to contact. The mode setting defaults to “full”. |
Primary Widget Color (Classic) | color , defaults to #CC6D00. The primaryColor setting defaults to “#cc6d00”. |
Enable Screenshots | boolean , defaults to TRUE . 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 | boolean , defaults to TRUE . Show the UserVoice Widget on Page Load |
Enable SmartVote | boolean , defaults to TRUE . Enable SmartVote |
Tab Color (Classic) | color , defaults to #CC6D00. The tabColor setting defaults to “#cc6d00”. |
Invert the Tab's Colors (Classic) | boolean , defaults to FALSE . The tabInverted setting defaults to false . |
Tab Label (Classic) | string , defaults to feedback . The tabLabel setting defaults to “Feedback & Support”. |
Tab Position (Classic) | select , defaults to middle-right. The tabPosition setting defaults to “middle-right”. |
Custom Ticket Fields | text-map , defaults to {}. This will allow you to set field value pairs for ticket custom fields (set via your admin console). |
Custom Trigger Selector | string . 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 | color , defaults to rgba(46, 49, 51, 0.6). This will change the background color of the trigger. It defaults to a translucent gray. |
Trigger Foreground Color | color , defaults to #FFFFFF. This will change the color of the text on the trigger, including the question mark. |
Trigger Position | select , defaults to bottom-right. The triggerPosition setting defaults to bottom-right |
This page was last modified: 27 Oct 2023
Need support?
Questions? Problems? Need more info? Contact Segment Support for assistance!