Integrating via query string parameters
In this article
- Introduction
- How to create suggestions via query string parameters
- How to set a user’s name and email via query string parameters
- Related content
Introduction
A simple way to integrate your site with Feature Upvote is by using HTML GET requests with query string parameters. You can:
- prefill the ‘Add Suggestion’ form.
- set a user’s name and email for any actions they might do while browsing your feedback board.
How to create suggestions via query string parameters
The URL is: https://yourfeedbackboard.featureupvote.com/suggestions/add
If you are using a custom domain name, then you can also use: https://customdomainname/suggestions/add
Note that the suggestion is not created until you explicitly submit the ‘Add suggestion’ form. These fields simply prepopulate the form with data of your choice.
Valid query string parameters are:
titledescriptionname- the name of the person making the suggestionemail- the email of the person making the suggestion
All fields are optional. Any other fields are ignored. All leading and trailing whitespace is trimmed. If necessary, the text will be truncated to fit the form’s maximum field lengths.
Standard URL parameter encoding must be used.
Example:
https://yourfeedbackboard.featureupvote.com/suggestions/add ?title=Add+PDF+Export&name=John+Smith&email=john@example.com
How to set a user’s name and email via query string parameters
This approach is available when you send users to your board’s home (the list of all suggestions).
The URL is: https://yourfeedbackboard.featureupvote.com/
If you are using a custom domain name, then you can also use: https://customdomainname/
Valid query string parameters are:
name- the name of the person you are sending to your boardemail- the email of the person you are sending to your board
Either field is optional. All leading and trailing whitespace is trimmed.
Standard URL parameter encoding must be used.
Example:
https://yourfeedbackboard.featureupvote.com/?name=John+Smith &email=john@example.com
Upon landing on your feature board, the name and email parameters are removed from the query string and internally stored for the duration of the user’s browsing session.
These parameters are used to populate the name and email fields when a user adds a new suggestion, adds a comment, and votes on an existing suggestion.