Deep Linking Schema for the Field Service Mobile App

URI Schema Format

Supported URI Schemes

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 doesn’t 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 doesn’t 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 doesn’t 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 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 1 MB, it’s best practice to encode smaller amounts of data.

Hide Deep Linking Security Dialog (Beta)

This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

Note

Each time a user opens a deep link to an action from the Field Service mobile app, a “Launch action” security dialog prompts the user to confirm the action. You can hide this dialog by configuring the deep link URL with a security key.

Complete the following steps to configure the security key.

Step 1: Create a private and public key

1. In the terminal, run these commands to create a private and public key. The .pem key files are created in the folder where you execute the commands.
   1openssl ecparam -genkey -name prime256v1 -noout -out private.pem
   2openssl ec -in private.pem -pubout -out public.pem

2. Keep a copy of the private.pem and public.pem files so that you can sign URLs in the future without generating new key pairs. The private.pem file contains the security key.
3. Open the public.pem file and copy the public key excluding the header and footer. This is a sample public key.
   1MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEkvkDcFieJenYABN8wOLlE2VomNt2
   29/tcTyj+B06ZndRkTjs7+XwrjHe/wOZvjkdYvewhIByLI6uDTYZixDhO1A==

4. Copy the public key into the Advanced Permissions section of the Field Service Settings UI. This step is required to turn on this feature.

   

Step 2: Sign the deep link URL

1. In the terminal, change directories to the folder containing the private.pem file.
2. Generate the deep link URL, and copy it to your clipboard.
   1// Base URL.
   2com.salesforce.fieldservice://v1/sObject/<id>/<action>
   3
   4// URL with additional query parameters.
   5com.salesforce.fieldservice://v1/sobject/<id>/<action>?param1=value1&param1=value2

3. To create a signature using the private key, run this command. This creates a signature using OpenSSL and Base64 encoding. pbpaste reads the deep link URL that you copied from the previous step and pbcopy copies the output signature into your clipboard.
   1pbpaste | openssl dgst -sha256 -sign private.pem | openssl base64 | tr '/+' '_-' | tr -d '=' | tr -d '\n' | pbcopy

4. Sign the deep link URL by adding the query parameter __signature=<sig> to the end of the URL. Replace <sig> with the signature, which you can paste from your clipboard. If you have additional query parameters, place the signature parameter after them.
   1// Signed URL.
   2com.salesforce.fieldservice://v1/sObject/<id>/<action>?__signature=<sig>
   3
   4// Signed URL with additional query parameters.
   5com.salesforce.fieldservice://v1/sobject/<id>/<action>?param1=value1&param1=value2&__signature=<sig>

Now you can send the deep link URL with the signature as before. When the technician clicks the URL, the deep link opens in the Field Service app. The app verifies the signature using the public key. If the public key hash matches, the URL is loaded without the “Launch action” dialog. If the public key hash doesn’t match, the user must confirm the action.