QuickCapture and custom URL scheme links

ArcGIS QuickCapture can be integrated with other apps using either a QuickCapture link or a custom URL scheme. Both methods support the same parameters, but there are platform-dependent differences between the methods.

QuickCapture links begin with https://quickcapture.arcgis.app and work on iOS and Android. QuickCapture 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. ArcGIS apps that you can open with an app link include ArcGIS Survey123, ArcGIS Field Maps, ArcGIS Workforce, and ArcGIS Navigator. The following is a link to launch a QuickCapture project from another ArcGIS app:

https://quickcapture.arcgis.app/?itemID=aabda4a5e36d42c2bcf1c479fe01e5e3

Custom URL scheme links begin with arcgis-quickcapture:// and work on Windows and Android. Custom URL scheme links cannot be shortened and can be difficult to open on Android. To assist opening on Android, consider presenting custom URL scheme links in the form of hyperlinks, similar to the following:

<a href="arcgis-quickcapture://?itemID=36ff9e8c13e042a58cfce4ad87f55d19">Open project</a>

QuickCapture links are the preferred method of linking between apps, and custom URL schemes are the preferred method for sharing projects.

Before using a link that contains parameters to launch a project in the mobile app, it is recommended that the app already be installed on the device.

URL parameters

You can use the following parameters to customize how the mobile app is opened:


Parameter	Description	Example	Type
`action`	Specifies how a project is opened. Supported values are `press` (to press an identified button) and `field` (to populate a field for a button press). Buttons are identified by a GUID, which is displayed at the bottom of the buttons Appearance tab in the QuickCapture designer.	To capture a point feature, or start or stop capture of a line or polygon feature: `action=press:0c59c9d9-9b51-46b3-bb81-21149e6fddb4` To capture a feature, and populate the diameter field of that feature with the value of 20: `action=press:0c59c9d9-9b51-46b3-bb81-21149e6fddb4&field:diameter=20`	String
`callback`	Specifies the URL to return to when a button is pressed.	`callback=https://survey123.arcgis.app`	URL
`center`	Centers the map to known latitude, longitude, and optional altitude.	`center=37.8199,-122.4783,20`	String
`externalBrowserSignIn`	Specifies to use an external browser for sign in.	`externalBrowserSignIn=true`	Boolean
`itemID`	Specifies the project to open.	`itemID=aabda4a5e36d42c2bcf1c479fe01e5e3`	UUID
`portalUrl`	Specifies the URL to the portal where the QuickCapture project item is hosted.	`portalUrl=https://myorg.arcgis.com`	String
`userInput`	Specifies the ID and value with which to populate the project user input variable.	`userInput:001=Alice`	String

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=867895a71a1840399476fc717e76bb43

The following is the same URL with encoded parameters:

https://survey123-mobile.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&callback=https%3A%2F%2Fquickcapture.arcgis.app%3FitemID=867895a71a1840399476fc717e76bb43

An 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.