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.
- 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.
When you call Identify, Segment sets the userId and traits included in the call on the current user in UserVoice. See the Identify method in the Segment Spec for details. An example call looks like:
1analytics.identify('ze8rt1u89', {2name: 'Zaphod Kim',3gender: 'Male',4email: 'jane.kim@example.com',5phone: '1-401-826-4421',6address: {7city: 'San Francisco',8state: 'Ca',9postalCode: '94107'10}11});
For more details on identifying users on UserVoice, see the UserVoice developer documentation.
When you call Group, Segment sets the traits included in the call on the current user's Account in UserVoice. See the Group method in the Segment Spec for details. An example call looks like:
1analytics.group("0e8c78ea9d97a7b8185e8632", {2name: "Initech",3industry: "Technology",4employees: 329,5plan: "enterprise",6"total billed": 8307});
For more details on grouping users on UserVoice, see the UserVoice developer documentation.
Calling Alias connects anonymous visitors to identified users. See the Alias method in the Segment Spec for details. An example call looks like:
analytics.alias("507f191e81");
For your implementation, make sure to replace "507f191e81" with your user's previous ID.
Segment lets you change these destination settings from the Segment app without having to touch any code.
Optional
Accent Color
#448dd6Your API Key appears in the javascript snippet URL as widget.uservoice.com/APIKEY.js. This setting is required.
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.
falseOptional
Select Mode
fullOptional
Your Forum ID appears in the JavaScript code snippet as forum_id: YOUR_FORUM_ID.
Optional
The linkColor setting defaults to "#007dbf".
#007dbfOptional
The mode setting defaults to "full".
contactOptional
The primaryColor setting defaults to "#cc6d00".
#CC6D00Optional
This will allow users to submit a screenshot of the current window when submitting a message with the contact form.
trueOptional
Show the UserVoice Widget on Page Load
trueOptional
Enable SmartVote
trueOptional
The tabColor setting defaults to "#cc6d00".
#CC6D00Optional
The tabInverted setting defaults to false.
falseOptional
The tabLabel setting defaults to "Feedback & Support".
feedbackOptional
The tabPosition setting defaults to "middle-right".
middle-rightOptional
This will allow you to set field value pairs for ticket custom fields (set via your admin console).
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.
Optional
This will change the background color of the trigger. It defaults to a translucent gray.
rgba(46, 49, 51, 0.6)Optional
This will change the color of the text on the trigger, including the question mark.
#FFFFFFOptional
The triggerPosition setting defaults to bottom-right
bottom-right