Field Service Lightning Developer Guide
jNewer Version Available
Deep Linking Schema for the Field Service Lightning Mobile App
Use the predefined URI schema for the Field Service Lightning mobile app on both Android
and iOS devices.
URI Schema Format
<com.salesforce.fieldservice>://v1/sObject/<id>/<action>
Let’s break down each parameter of the URI scheme format.- com.salesforce.fieldservice—The supported Salesforce schema name.
- v1—The current version of deep linking. This is a static value.
- sObject—Indicates a single instance of a Salesforce object. The schema supports all object types that are supported in the Field Service app, such as work order, service appointment, and assets.
- id—The unique single instance of a Salesforce object. id lengths of 15 and 18 characters are supported.
- action—A supported URI schema operation. Valid actions are listed in the Supported URI Schemes section. If no action is specified, URIs for work orders and service appointments direct to the Overview tab. URIs for any other object type direct to the Details tab.
- api_name—Some deep links require an API name in order to perform their function. For instance, the quick action URI requires a quick action API name, and the flow URI requires a flow API name.
Supported URI Schemes
- com.salesforce.fieldservice://v1/sObject/<id>
- Links to the Overview tab for work orders and service appointments. Links to the Details tab for all other object types. When linking to a work order with multiple service appointments, the first service appointment in the related list is used in the work order Overview tab.
- Example: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA
- This example links to the Overview tab for a work order.
- com.salesforce.fieldservice://v1/sObject/<id>/details
- Links to the Details tab for all object types.
- Example: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/details
- This example links to the Details tab for a work order.
- com.salesforce.fieldservice://v1/sObject/<id>/related
- Links to the Related tab for all object types.
- Example: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/related
- This example links to the Related tab for a work order.
- com.salesforce.fieldservice://v1/sObject/<id>/products
- Links to the Products tab for all applicable object types. If an object does not have a Products tab, it links to the Details tab instead.
- Example: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/products
- This example links to the Products tab for a work order.
- com.salesforce.fieldservice://v1/sObject/<id>/feed
- Links to the Feed tab for all applicable object types. If an object does not have a Feed tab, it links to the Details tab instead.
- Example: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/feed
- This example links to the Feed tab for a work order.
- com.salesforce.fieldservice://v1/sObject/<id>/location
- Links to the Location tab for all applicable object types. If an object does not have a Location tab, it links to the Details tab instead.
- Example: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/location
- This example links to the Location tab for a work order.
- com.salesforce.fieldservice://v1/sObject/<id>/edit
- Links to the edit page for the specified Salesforce record.
- Example: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/edit?Subject=Example%20Subject
- This example links to the edit page for this record and fills the “Subject” field with the “Example Subject” value.
- com.salesforce.fieldservice://v1/sObject/<id>/createservicereport
- Creates a service report for a particular work order or service appointment. The <id> value must specify a work order or service appointment record.
- Example: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/createservicereport
- This example creates a service report for the work order or service appointment.
- com.salesforce.fieldservice://v1/sObject/<id>/flow/<api_name>
- Launches a Field Service Mobile Flow from within the mobile app. For example, you can use this URL to launch a custom service closure flow. To use this feature, the app extension must reference this flow. You can find the extension in Setup under Field Service Mobile Settings. Verify that an extension in the App Extensions section includes this flow. To learn more, see Connect a Flow to the Field Service Lightning Mobile App. Use the URL-encoded name of the extension in the URI.
- Example: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/flow/service_response_flow?Subject=Example%20Subject
- This example launches the “service_response_flow” flow passing in “Example Subject” as the value for the “Subject” input variable.
- com.salesforce.fieldservice://v1/sObject/<id>/quickaction/<api_name>
- Launches a quick action from within the mobile app. The following quick action types are supported: Create a Record, Update a Record, and Field Service Mobile Extension. You can pass inputs into the quick action using parameters on this URL.
- Example: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/quickaction/close_order
- This example launches the “close_order” quick action.
Parameter Passing for Deep Linking
To pass parameters in a deep linking schema such as a quick action or flow URL, the following parameter types are valid.
- URL-encoded text parameters; for example, Short%20text%20input
- Numbers or currency; for example, 1 or 1.45
- Boolean values; for example, true or false. These values aren’t case-sensitive. If no parameter is passed, the default is false.
- URL-encoded date and dateTime parameters; for example, 2019-12-11T17%3A01%3A00.000%2B0000. Include a URL-encoded timezone, such as +0000 (GMT) or -0400 (AST).
Other parameters aren’t supported in deep linking URI schema.
To pass more than one parameter, use an ampersand (&) between them; for example, firstname=John&lastname=Doe.
We don’t limit the number of parameters, and each parameter value can contain up to 100,000 characters. While deep links can encode up to 1MB, it’s best practice to encode smaller amounts of data.