Launch Survey123 Mobile

You can create links to open Survey123 Mobile from another app, a web map pop-up, or a hyperlink in an email or website. Use a custom URL scheme to launch the app from a web browser, or use a Survey123 app link to launch it from an app on Android or iOS. Use URL parameters to customize how Survey123 Mobile opens, such as to load a specific survey, set coordinates for the default map location, and populate answers to questions with predetermined values or by passing data attributes from a web map pop-up.

Link from a web browser on Windows

You can create a link to open Survey123 Mobile that can be embedded in another app. The same link can also be entered into a web browser for testing.

Note:

Once you create the link, you can replace arcgis-survey123-mobile:// with https://survey123-mobile.arcgis.app as the Survey123 link for use on iOS or Android.

To create a custom URL scheme and use it in a desktop web browser, complete the following steps:

1. Type arcgis-survey123-mobile:// into your browser.

   Survey123 Mobile opens (or you are prompted to open it).

   Note:

   To launch and download a survey from a specific portal, include the portal URL parameter, for example, arcgis-survey123-mobile://?portalUrl=host.domain.com/webadaptor (in which host, domain, and webadaptor are replaced by your portal information).

2. Add a unique reference to a survey and add it to the URL by doing the following:
   1. Identify the item ID of the survey you want to open.

      Note:

      This is the string of characters that ArcGIS Online uses to uniquely identify the survey and can be found in the URL of your form item in ArcGIS Online. For example, if the survey's URL is https://exampleurl.maps.arcgis.com/home/item.html?id=36ff9e8c13e042a58cfce4ad87f55d19, your form's item ID is 36ff9e8c13e042a58cfce4ad87f55d19.

   2. Include the survey in the URL by adding ?itemID= and your form's item ID to the end of the URL.
   The URL should look similar to the following:

   arcgis-survey123-mobile://?itemID=36ff9e8c13e042a58cfce4ad87f55d19

   If you test the URL, it should open Survey123 Mobile and immediately open the survey.

   Note:

   If it's not already on your device, the survey is downloaded to it.

3. Include predetermined answers to questions by adding a reference in the URL to a field using the name assigned to it in XLSForm (not its label).

   For example, to populate the Surname field, type &field:surname= and the value.

   The & acts as a parameter separator and field: refers to the question name to be populated.

   The URL should look similar to the following:

   arcgis-survey123-mobile://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser

   You can now use the URL to open Survey123 Mobile and the survey and fill in the given question with the answer you defined. You can populate multiple questions in the one survey URL. Field names are case sensitive.

4. Define a location for a geopoint question in the survey by adding coordinates to the URL as follows:
   1. Type &center=, and type the coordinates.
   2. Type the latitude and longitude coordinates in decimal degrees, separated by a single comma.
   3. Optionally, add altitude in decimal meters as a third value, also separated by a single comma.

   The final URL should look similar to the following:

   arcgis-survey123-mobile://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser&center=37.8199,-122.4783,20

   This URL will now open Survey123 Mobile and the chosen survey, populate a text question, and provide a new default location for the geopoint question.

   Field attributes can also be passed to Survey123 Mobile from a pop-up in an ArcGIS web map, allowing integration with other Esri apps that use pop-ups in a web map. This capability can be used to populate a field in Survey123 Mobile with the value of a feature attribute, rather than a set value, by providing the name of the attribute enclosed in curly brackets.

5. Open the web map, select Pop-ups for one of the layers, choose Add content, select Text, provide the text to display for the link, and click the Link button to enter the Link URL value.

Link from another app on iOS or Android

You can create a link for use in ArcGIS apps to open Survey123 Mobile and capture data in a survey. The steps below describe how to create a Survey123 app link and use it in a web map pop-up. This link is entered in the pop-up of a web map in your ArcGIS organization. You can test the link using a web browser (using similar steps as in the preceding section) on an iOS or Android device.

1. Open a web map that will be viewed on the device, and select Pop-ups for one of the layers.
2. Choose Add content, and select Text.
3. Type Launch Survey123, highlight this text, click the Link button to enter the link URL, type https://survey123-mobile.arcgis.app, click OK, and do the following
   1. Open the web map on a mobile device from either a browser or an ArcGIS app.
   2. Select a feature, and click the Launch Survey123 link in the pop-up to open Survey123.
4. To include the survey in the URL, add ?itemID= and your form's item ID to the end of the URL.
   The URL should look similar to the following:

   https://survey123-mobile.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19

   If you test the URL, it should now open Survey123 Mobile and immediately open the survey.

   Note:

   If it's not already on your device, the survey is downloaded to it.

5. Include predetermined answers to questions by adding a reference in the URL to a field using the name assigned to it in XLSForm (not its label).

   For example, to populate the Surname field, type &field:surname= and the value.

   The & acts as a parameter separator, and field: refers to the question name to be populated.

   The URL should look similar to the following:

   https://survey123-mobile.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser

   You can now use the URL to open Survey123 Mobile and the survey, and you can fill in the given question with the answer you defined. You can populate multiple questions in the one survey URL. Field names are case sensitive.

6. Define a location for a geopoint question in the survey by adding coordinates to the URL as follows:
   1. Type &center=, and type the coordinates.
   2. Type the latitude and longitude coordinates in decimal degrees, separated by a single comma.
   3. Optionally, add altitude in decimal meters as a third value, also separated by a single comma.

   The final URL should look similar to the following:

   https://survey123-mobile.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser&center=37.8199,-122.4783,20

   This complete URL now opens Survey123 Mobile and the chosen survey, populates a text question, and provides a new default location for the geopoint question.

URL parameters for launching Survey123 Mobile

The following parameters can be used to customize how Survey123 Mobile is opened:

Parameter	Description	Type
center	Centers the map to known latitude, longitude, and optional altitude values. Example: center=37.8199,-122.4783,20	String
field:fieldname	Populates survey questions with field values. Example: field:surname=Klauser	String
portalUrl	The URL to the portal where the survey item is hosted. Example: portalUrl=https://myorg.arcgis.com	String
itemID	The form to open. Example: itemID=36ff9e8c13e042a58cfce4ad87f55d19	UUID
download	Automatically downloads the survey when the device is online. The default is true. Example: download=false	Boolean
callback	The URL to return to when a form action (for example, submit, move to drafts, cancel, or exit) is completed. Example: callback=https://quickcapture.arcgis.app	URL
callback:status	Example: callback:draft=https://quickcapture.arcgis.app	String