ArcGIS Survey123 can be integrated with other apps by using links to launch the specific component app. For example, you can create app links to launch and open Survey123 Mobile from another Esri app, a web map pop-up, or a simple hyperlink in an email or website. You can use a URL to automatically download and open a survey for editing in Survey123 Connect.
You can also link to other apps from Survey123, such as ArcGIS QuickCapture and ArcGIS Field Maps.
Tip:
Survey123 Mobile opens links for three apps: Survey123 Mobile, the Survey123 field app, and QuickCapture. When any of these links are launched from within Survey123 Mobile (from Use a link, Scan a QR code, or from a link inside a survey or QuickCapture project), they will open inside Survey123 Mobile. For more information, see Open content.
Use the URL patterns in the table to create links for access from a web browser or another app. The included examples show how to open a specific survey using these URL patterns.
| What to launch | Where to link from | URL pattern to use |
|---|---|---|
| Survey123 Mobile | Android iOS | Survey123 app link1: Example: |
Windows Android iOS2 | Custom URL scheme3: Example: | |
Web app | Web browser | Survey form by ID: Example: |
Field app | Android iOS | Survey123 app link1: Example: |
Windows Android iOS2 | Custom URL scheme3: Example: | |
| Survey123 Studio | Windows | Custom URL scheme3: Example: |
Survey123 Connect | Windows | Custom URL scheme3: Example: |
Another app | Survey form | Link from Survey123: Varies by app |
1—Survey123 app links conform to requirements set by the App Store and Google Play, enable linking to more apps, and support shortened links that are easier to share.
2—On iOS devices, custom URL schemes are only approved for a select group of apps.
3—Custom URL scheme links cannot be shortened and can be difficult to open on Android. Consider presenting custom URL scheme links in the form of hyperlinks, similar to the following:<a href="arcgis-survey123-mobile://?itemID=36ff9e8c13e042a58cfce4ad87f55d19">Open survey</a>
URL parameters
You can add URL parameters to the end of the links to further customize how the app opens. For example, you can set the default location for a geopoint question or populate a text question.
URL parameters begin with the character ?, and are separated by the character &. The following example shows a custom URL scheme, with the first parameter (itemID) beginning with the character ?, and each of the subsequent field parameters (color_1 and color_2) separated with the character &.
arcgis-survey123-mobile://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:color_1=red&field:color_2=blueFor more example URLs and supported URL parameters, refer to Launch Survey123 Mobile, Feature functions | ArcGIS Arcade | Esri Developer, Launch the web app, Launch the field app, Launch Survey123 Connect, and Launch another app from Survey123.
Note:
Before using a link that contains parameters to launch a survey in Survey123 Mobile or the field app, it is recommended that the app already be installed on the device. For more information, see Install ArcGIS Survey123.
URL encoding
Although URL parameters that are not encoded work in some environments, it is recommended that you encode URL parameters. Encoding replaces invalid characters with the percent sign (%) followed by their hex equivalent.
For example, the following is a Survey123 link that uses a callback to return to a specific project in QuickCapture with parameters that are not encoded:
https://survey123-mobile.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&callback=https://quickcapture.arcgis.app?itemID=867895a71a1840399476fc717e76bb43The following is the same URL with encoded parameters:
https://survey123-mobile.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&callback=https%3A%2F%2Fquickcapture.arcgis.app%3FitemID=867895a71a1840399476fc717e76bb43An equal sign that specifies a break between a key and its value should not be encoded.
Tip:
One way to create encoded parameters is to use ArcGIS Arcade. The UrlEncode function allows you to define a collection of key value pairs that represent each parameter and produce a URL with appropriate encoding.
A survey author may also want to obscure URL parameters so that sensitive data is not visible in the URL. In this case, when you create a URL to use in the web app, include encodeUrlParams=true. For more information, see URL parameters for opening the web app.