Setup custom Web / Service Hooks

Web or Service Hooks will allow you to push UserVoice events to any URL.

In this article, we will walk through what's possible with this feature. If you are looking for additional functionality, please share your ideas on our feedback forums.

1. Create a custom Web Hook in UserVoice

  1. Sign in to your Admin Console.
  2. Click the icon in the bottom left corner.
  3. Choose "Integrations" from the drop-down menu.
  4. Click "Service hooks"
  5. You will either see an icon that says "Web Hook" or a link "Custom web hook." Click on it to set up.

Set which events you want to push

Choose Individual Forums: By default, events will be pushed across forums, but if you check this option, you will then be able to choose to only push events from specific forums.
  • New Forum
  • New Suggestion
  • New Comment
  • New Suggestion Status Update
  • Suggestion Votes Update
Specify how our API will be polled (either XML or JSON).

Enter the Callback URL. 

2. Set up your Application

You will need an engineer on your end to set this up for you. While our team is limited in giving guidance on how your application needs to be configured for this, we recommend the following:

  • In addition to reading the 'data' parameter (JSON or XML) in your application, you might want to check the 'signature' parameter if you want to make sure the request is coming from UserVoice. To calculate the signature, use HMAC-SHA256 with your SSO key (in Admin Console Settings -> Web Portal -> UserVoice Authentication -> Edit, copy-paste SSO KEY) as the key and 'data' as the message.
  • Check out our code examples at uservoice-service-hooks repository on GitHub. Our service hooks are just simple Ruby classes that define a few user-configurable fields, provide messages for our different event types and include a method for shipping the data off to your app. Just fork that repo, write a Service Hook and some tests, and submit a pull request!

Common Questions

Q: Can I push events from single forum?
A: Yes! When you set up the Service Hook, you can choose a specific forum to push events to. 

Feedback and Knowledge Base