Use deep links to the Field Service mobile app

Deep links let users move from one application to another on computers and mobile devices. Simple examples include a mobile app deep-linking to Facebook to sign in, an email address deep-linking to a mail app to compose a message, or a website deep-linking to an app store to download a related mobile app. Because multiple apps might be needed to complete onsite work, an organization can allow technicians to create deep links from the Dynamics 365 Field Service mobile app to other apps and vice versa.

Open an entity record or entity list view in the mobile app

You can open an entityrecord or an entitylist view in the Dynamics 365 Field Service mobile app by using deep link URLs from other apps. When you follow the link from an external app, the target element opens in the Field Service mobile experience.

If you're already signed in to your instance in the app, the target record is displayed when you follow the link from an external app. Otherwise, you're prompted to sign in to your instance in the mobile app; after you're signed in, the target element is displayed. You must have the Field Service mobile app to use this feature.

Query string parameters for the URL

Use the following application handler and query string parameters to compose the URL.

Deep links for Field Service should start with the following:

ms-apps-fs://<org-url>_<app-id>?tenantId=<tenant-id>&isShortcut=true&appType=AppModule&openApp=true&restartApp=true&forceOfflineDataSync=true

Parameter Description
<org-url> Connects to the correct org URL
<app-id> Opens the correct app module
tenantId Connects to the correct tenant
forceOfflineDataSync Ensures that data sync is triggered so that all the latest data is available

If opening an entityrecord form or creating a new entityrecord, use the following parameters.

Parameter Description
etn=<entity-logical-name> Designates which entity to go to
pagetype=entityrecord Indicates that the target is a form
extraqs=<form-id> Designates which form to open for the entityrecord; if not specified, the default form will open. The extraqs parameter can also be used to default field values.
id=<record-id> Designates which specific record to go to; if left blank, the create form for the entity will open

If the link goes to an entitylist view, add the following parameters.

Parameter Description
etn=<entity-logical-name> Designates which entity to go to
pagetype=entitylist Indicates that we're going to a view
viewid=<view-id> Designates which view to open
Viewtype= <1039 if system view, 4230 if personal view> Designates whether we're going to a system view or a personal view

Example URLs

Action Example of a deep-link URL
Open a create form for Bookable resource booking ms-apps-fs:// <org-url>_<app-id>?tenantId=<tenant-id>&isShortcut=true&appType=AppModule&openApp=true&restartApp=true&forceOfflineDataSync=true&etn=bookableresourcebooking&pagetype=entityrecord&id=
Open a Bookable resource booking with id=xyz ms-apps-fs:// <org-url>_<app-id>?tenantId=<tenant-id>&isShortcut=true&appType=AppModule&openApp=true&restartApp=true&forceOfflineDataSync=true&etn=bookableresourcebooking&pagetype=entityrecord&id=xyz