Embedding Voxpopme in Qualtrics

Voxpopme Help Team UK -

This article gives a step by step guide on how to embed Voxpopme into the Qualtrics platform. Please see our document How to set up your Embed project in the Portal if you would like to complete this step first or keep reading if you have been sent the Javascript already.

First, add in the question you'd like to ask respondents as a text description.


Switch to the HTML view, and copy in the below:

<div class="vpm-capture-widget"></div>



Next, you will need to add in the Javascript embed code. Select the ‘Cog’ icon on the left-hand side of the question, and then select ‘Add Javascript’.


Copy the embed code below into the Javascript box, make sure to replace [project-id] with the Project ID from your project. This may have been provided to you by a member of the Voxpopme team or this is also available in the Voxpopme portal. To access this ID in the portal select your Project and use the Responses drop-down to select Summary. Be sure to remove the brackets and keep the quotation marks.

var vpm_widget_config;
Qualtrics.SurveyEngine.addOnload(function (){
var qualtricsThis = this;
setTimeout(function(){ document.getElementById('NextButton').style.display = 'none' }, 1000);
document.getElementById('NextButton').style.display = 'none';

vpm_widget_config = {

   project_id: "[project-id]",
   additional_data: {
       'ResponseID': '${e://Field/ResponseID}'
   settings: {
       locale: "en_US"
   disable_next_button: function() {
       document.getElementById('NextButton').style.display = 'none';
   enable_next_button: function() {
       document.getElementById('NextButton').style.display = 'block';
var vpm = document.createElement('script'); vpm.type = 'text/javascript'; vpm.async = false;
vpm.src = 'https://capture.voxpopme.net/javascripts/app.js';


Appending Data

1. Ensure you are passing through additional data to the Voxpopme portal. At minimum we recommend passing through a unique identifier so the survey results can be tied to the videos captured. The embed code above includes appended data capture titled ‘additional_data’. The name of the variable is shown on the left-hand side in single quotation marks. The appropriate piped text for passing through additional data within the survey is on the right in single quotation marks. The ResponseID is already included as additional data in the example Javascript above. ResponseID is generated by Qualtrics and this code should work for the ResponseID for every project. 

2. Additional Survey Variables: Pass through as much additional data as you would like to the Voxpopme platform. To add a new piece of additional data you will need to add a comma at the end of last additional data line. If you’re passing through a survey response as additional data, use the same piped text you would use to pipe that response into another survey question. For example '${q://QID2/ChoiceGroup/SelectedChoicesTextEntry}'.


        additional_data: {

        'ResponseID’: '${e://Field/ResponseID}’,

        'Age': '${e://Field/Age}',

        'GENDER': '${q://QID4/ChoiceGroup/SelectedChoices}'


Note when passing through the unique identifier in Qualtrics, you will need to use the Survey Flow to insert Embedded Data. Set the Custom Value to your unique identifier, Qualtrics will then provide the merge code you will need to include in the embed code. Simply replace the area in the square brackets shown in the embed code above with the appropriate merge code for Qualtrics, for example 'Respid' would be '${e://Field/respid}'.

3. Previous survey answers can also be passed through to the portal. To add a new piece of additional data you will need to first off add a comma at the end of last additional data line, then add a new line. On the new line, add in the name of the variable in single quotation marks (similar to the example above), next add a colon, and then add in the appropriate merge code for this additional data in single quotation marks. If this is a previous survey answer, the same merge code to pipe through previous survey answers within your survey can be used. For example '${q://QID2/ChoiceGroup/SelectedChoicesTextEntry}'.



If you're setting up a non-English language survey, ensure you've changed the Locale code. This will notify the system of the language that responses are expected to be in. Check out the list of languages available.


While testing the video capture and additional data passthrough for your survey, be sure to say “testing” in your video or cover your camera. This will let our QA team know to decline the video. Below are instructions on how to view the additional data in the portal, and how to see declined test videos to confirm data has passed through correctly.

View additional data in portal: To view the additional data in the project, click into your project and click the additional data button (see screenshot below). The additional data will show up beneath each response’s transcript.



View Declined Videos: If your test video is awaiting approval, you can skip this step and use the instructions above to view the additional data. If you don’t see your test video, it was likely declined by our QA team, which prevents the video from being sent for transcription. You can see these videos by using the Filter and setting Declined to True. See screenshot below:


Recommended Options

Technical Difficulties

Because the embed code will disable the 'Next' button within the survey until the respondent has successfully uploaded a video response, we recommend adding a technical difficulties option in case a respondent is unable to record a video or decides they no longer wish to record. Follow the instructions below to include this option:

1. Add a Multiple Answer question underneath the capture widget so that respondents have the ability to unselect the answer if they change their mind. Make sure Force Response or Request Response Validation is NOT applied. Include only one answer choice with the text 'I'm having technical difficulty or would no longer like to record' or something similar.

2. On the Multiple Answer question you will need to include a separate snippet of Javascript that will enable the 'Next' button if the respondent selects the technical difficulties checkbox. To include this, click the 'Cog' icon on this question, select 'Add Javascript', and paste in the Javascript in step 3.




   this.questionclick = function(event,element){
       if (element.type == 'checkbox'){
           if (element.checked){
           } else {


4. TIP: Check the Look & Feel for a “Questions per page” setting to ensure the technical difficulties question is showing up on the same page of the survey as the video question.

5. Save your Javascript and test through your survey. Ensure the 'Next' button is appropriately disabled/enabled, and that the additional data is being passed through successfully to the portal. If you have any questions, please contact the Voxpopme team. When your survey is ready, share a test link with the Voxpopme team so we can ensure everything is working correctly.

Checking the Project Quota

If you would like to prevent the respondent from seeing the video question once the video quota has been met, follow the instructions in the following link: Checking the quota

Changing the Recording Time

By default, the widget allows respondents to record responses between 15 and 60 seconds. To change the minimum and maximum recording time capture widget please check with your contact at Voxpopme.

Practical tips for higher conversion rates

Read our document for tips on how to gain higher conversion rates.

Have more questions? Submit a request


Article is closed for comments.