Once participants have been added to your project, they can complete surveys a variety of ways:
- Logging into the app and completing any incomplete survey tasks.
- Clicking a link from a notification that either:
- Directs the participant to complete a survey via web (no login required).
- Directs the participant to complete a survey via the app.
You can also allow potential participants that have not yet been added to your project to complete surveys via web without ever creating an account or installing the app by utilizing new participant survey links.
The following article will discuss how to implement survey links in notifications for participants who have already been added to your project.
Table of Contents
Web Survey Links vs Deep Survey Links
A web survey link refers to a link that, when clicked, opens the participant’s survey on the web, without requiring the participant to login to the app. These can be beneficial for projects that don’t require the participant to login to the app frequently or at all, and can be used in both email and SMS notifications.
A deep survey link refers to a link that, when clicked, opens the participant’s survey within the app. These can be beneficial if participants are expected to have the app downloaded on their mobile device, especially if they are expected to interact with the app frequently, and can be used in email, push, or SMS notifications.
Both options allow for a better participant experience if using notifications to inform and remind participants of survey tasks that are due, since these reduce friction to getting to the survey itself.
Creating Web Survey Links
Web survey links can be created while configuring SMS notifications or by adding expressions to email notifications.
Links in SMS Notifications
Web survey links can be generated while creating SMS notifications, and allow you to define the following:
- Survey: The survey that will be launched when the link is clicked.
- Require Incomplete Task: Only allow participants to launch the survey if they have an incomplete survey task (i.e., if they don’t have a survey task for the survey associated with the link, or they have already completed the survey, the survey won’t launch).
- Expiration Hours: Hours before the link will expire. If left blank, the link will never expire.
- Follow Up Action: Direct participants to complete another survey or to open MyDataHelps account registration.
Use the “open MyDataHelps account registration” follow up action if directing participants to complete the consent survey via web before creating a MyDataHelps account.
For example, to create an SMS notification that directs participants to complete a demographic survey via web:
- Under Link, select “Web Survey Link (No Login).”
- Select the Demographics survey.
- Check Require Incomplete Task.
- Leave Expiration Hours blank.
- Leave Follow Up Action blank.
Links in Email Notifications
Use expressions to add a web survey link to an email notification. These should take the following form:
<%= WebSurveyLink("SurveyName") %>
where SurveyName is the name of the survey that should be launched.
These expressions must be inserted into the email notification using html:
<a href='<%= WebSurveyLink("SurveyName") %>'>Click here</a>.
For example, to insert a web survey link to the Demographics survey in an email, see below.
Creating Deep Links
Deep survey links can be created while configuring push or SMS notifications or by adding expressions to email notifications.
In addition to deep survey links, you can also create deep tab links, which take the participant directly to a tab within the app.
Links in Push & SMS Notifications
Deep survey links can be generated while creating SMS or push notifications, and allow you to define the following:
- Survey: The survey that will be launched when the link is clicked.
- Require Incomplete Task: Only allow participants to launch the survey if they have an incomplete survey task (i.e., if they don’t have a survey task for the survey associated with the link, or they have already completed the survey, the survey won’t launch).
- Tab Key: The tab that the participant will be directed to within the app.
For example, if your project sends out a weekly exercise survey every Sunday morning, you could create a push notification that directs participants to complete the Exercise survey via the app. Further, you could have the app open to the My Data tab in the background so that the participant sees their device data once they submit the survey. To implement this:
- Under Link, select “Deep Survey Link (Open Survey in MyDataHelps).”
- Select the Weekly Exercise survey.
- Check Require Incomplete Task.
- Select My Data as the Tab Key.
Deep tab links can be created by selecting a link type of “Deep Tab Link (Open Tab in MyDataHelps),” and the only field required is the Tab Key. For example, if you didn't have a weekly survey, but wanted to send a push notification encouraging participants to exercise, you could direct participants to the My Data tab upon clicking the notification to show them their device data.
Links in Email Notifications
Use expressions to add a deep survey link or deep tab link to an email notification. These should take the following form:
<%= DeepSurveyLink("SurveyName") %><%= DeepTabLink("TabName") %>
Where "SurveyName" is the name of the survey that should be launched and "TabName" is the name of the app tab that should be launched.
These expressions must be inserted into the email notification using html:
<a href='<%= DeepSurveyLink("SurveyName") %>'>Click here</a>.
For example, to insert a deep tab link to the participant's Reports tab into an email notification, see below.
[Legacy] Using Survey Links Prior to 2023
For projects initiated before 2023, survey links may take on the form below. These links act similar to web survey links, opening a web browser to complete the survey.
https://mydatahelps.org/mydatahelps/<%LinkIdentifier%>/surveylink/?surveyName=Welcome%20Survey
In this link format, the <%LinkIdentifier%> is used to create a link that is customized for each participant it's delivered to.
This type of link requires URL encoding on any special characters in your survey name, including spaces. For example, a space is "%20"; "Welcome Survey" would become "Welcome%20Survey".
Survey Link URLs do not work for Push notifications.
To enable survey completion via link for projects using this legacy link type, “Allow Embedded Survey Completion Via Link Identifier” must be selected within the survey settings.