Categories
Web Development

UserVoice Gadget API

I wanted to learn what data is sent by the UserVoice Inspector Gadgets (I do appreciate the name 😉), but there was no information I could find online.

Here’s some basic information about the HTTP request that is made by the Gadget.


UserVoice Custom Gadget Webhook Data

In the examples below, assume we set the URL of the Gadget to “https://example.com”.

The following is the structure of the query parameters passed to the provided URL in a GET request:

UserVoice Custom Gadget Headers:

HeadersValue
connectionclose
accept-encodinggzip, deflate, br
refererhttps://[your-subdomain].uservoice.com/
accept-languageen-us
user-agentMozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.1 Safari/605.1.15
accepttext/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
content-lengthEmpty
content-typeEmpty

URL Query String Parameters

The values are all URL-encoded. In the table below, they are shown decoded.

Query StringsExample ContentDescription
email[email protected]Email
nameExample JonesThe full name of the customer being supported.
guidnull
Note: “null” is passed as a string, not empty value.
Not sure what could be passed here (in this Gadget context).
user_id123064775The UserVoice User ID of the user you are currently supporting.
ticket{"id":"410535635","ticket_number":"123","created_at":"2019-11-10T08:42:34-05:00","updated_at":"2020-08-08T09:24:36-04:00"}Encoded JSON with information about the ticket you are viewing. Includes ID, Ticket Number, Created At timestamp, Updated At timestamp

Here’s the raw URL pinged by UserVoice:

https://example.com?email=example.jones%40example.com&guid=null&name=Example%20Jones&ticket%5Bid%5D=410535635&ticket%5Bticket_number%5D=123&ticket%5Bcreated_at%5D=2019-11-10T08%3A42%3A34-05%3A00&ticket%5Bupdated_at%5D=2020-08-08T09%3A24%3A36-04%3A00&user_id=123064775

What’s a Custom Gadget?

To add a Custom Gadget, when viewing a ticket, click the gear icon in the top-right corner of the sidebar (what UserVoice calls the “Inspector”).

Then click “Add/Remove Gadgets”:

Then click “Add custom gadget” at the bottom of the Gadgets for Inspector settings page:

You will be presented with a modal asking you to name your Gadget and provide a URL…with no additional information available.


I hope this has helped anyone else hoping to learn more about how to create a UserVoice Custom Gadget!

By Zack Katz

Zack Katz is the creator of GravityView and the President of Katz Web Services. He lives in Denver with his wife and cute beast of a cat.