External questionnaire integration guide
Under certain circumstances, you may want to use an external questionnaire platform (e.g., Qualtrics, SurveyMonkey, etc.) to host and manage your experiment questionnaires instead of using VERA’s built-in questionnaire functionality. This can be useful if you want to take advantage of specific features offered by these platforms, or if you already have an existing questionnaire set up on one of these platforms that you want to use in your experiment.
Importing questionnaires to VERA
VERA provides support for importing questionnaires directly from text files. VERA currently supports importing questionnaires from two different formats:
VQF format: A YAML-based format used internally by VERA. Any VERA questionnaire can be directly exported to VQF format, and then re-imported to VERA if needed. You can also create your own VQF files from scratch and import directly if needed.
Qualtrics QSF format: A file format used by Qualtrics to export questionnaires. If you have an existing questionnaire in Qualtrics, you can export it as a QSF file (In Qualtrics, select “Tools” > “Export Survey” > “Export as QSF”), and then import that QSF file directly into VERA.
To access the questionnaire import functionality, open the Questionnaires card on the Experiment Setup page, and click the Custom Questionnaire Importer button. More details on importing questionnaires can be found from this importer, including instructions on how to format your questionnaire files for import, and how to troubleshoot common issues with questionnaire imports.
Using external questionnaires in your experiment
If you want to use an external questionnaire platform directly to host your questionnaires, you can do so via an interception between your recruitment platform and VERA.
Warning
This method is not recommended, as it can lead to a more complex and error-prone experiment setup, and may require custom development work to set up the necessary integrations. If possible, consider using VERA’s built-in questionnaire functionality, or importing your questionnaires to VERA using the methods described above.
To integrate with an external questionnaire platform:
Send participants from your recruitment platform to your external questionnaire platform first.
At the end of your questionnaire on the external platform, include the link to your VERA experiment.
Participants will complete the questionnaire on the external platform, then click the link to be sent to your VERA experiment.
Once you have completed these steps, it will be necessary to associate the participant’s questionnaire responses with their VERA experiment session. To do so, you will have to save some identifying information about the participant. This process will vary depending on your specific recruitment platform and external questionnaire platform.
For example, consider a scenario where you are using Prolific as your recruitment platform, and Qualtrics as your external questionnaire platform. In this case, follow the process below to associate participant questionnaire responses with their VERA experiment session:
In Prolific, set your study URL to point to your Qualtrics questionnaire. Make sure to pass the Prolific ID as a query parameter in the URL (e.g., https://your-qualtrics-questionnaire-url?PROLIFIC_PID={%PROLIFIC_PID%}).
In Qualtrics, go to the “Survey Flow” section of your questionnaire, and add a new “Embedded Data” element at the start of the questionnaire flow. In this embedded data element, create a new field called “PROLIFIC_PID”, and set its value to the query parameter you passed in the URL (e.g., ${e://Field/PROLIFIC_PID}).
At the end of your Qualtrics questionnaire, include a link to your VERA experiment, ensuring you pass the Prolific ID as a query parameter in the URL (e.g., https://vera-xr.io/your-vera-experiment-url?PROLIFIC_PID=${e://Field/PROLIFIC_PID}).
In this way, participants will go from Prolific to Qualtrics, where their Prolific ID will be captured and stored in the embedded data. Then, when they click the link to go to your VERA experiment, the Prolific ID will be passed along in the URL. In your VERA experiment, the Prolific ID will then be directly associated with the participant’s experiment session, allowing you to link their questionnaire responses from Qualtrics with their experiment data in VERA.