Pulsar Deep Links
- Kevin Jenkins
- Andres Becerra
- geevall
- 1 Introduction
- 1.1 General Format
- 1.2 Parameters
- 1.2.1 Object Selectors
- 1.2.2 Arguments
- 2 Supported Actions
- 2.1 view
- 2.2 edit
- 2.3 update
- 2.4 create
- 2.5 list
- 2.6 quickaction
- 2.7 flow
- 2.8 launchdocument
- 2.9 custom_oauth
Introduction
A Pulsar Deep Link is a specially crafted URL that takes a user directly to a specific page or action in Pulsar for Salesforce — bypassing the usual navigation or clicking sequence. Unlike a standard homepage or dashboard link, a Deep Link points users precisely where they need to go, such as a particular Salesforce record or a custom Pulsar action. You can interact with Pulsar from websites and other apps on your device through the use of deep links.
Starting with Pulsar version 13.0.0, Pulsar supports two forms of deep links:
App-specific schemes (URI’s prefixed with the
pulsar://scheme):
pulsar://{action}/{objectType}?parameter1=value1¶meter2=value2Universal Links (URI’s prefixed with the Luminix website and
https://scheme:
https://www.luminixinc.com/pulsarapp/{action}/{objectType}?parameter1=value1¶meter2=value2The below documentation uses the App-specific scheme, but you can replace pulsar:// with https://www.luminixinc.com/pulsarapp/ in all the examples below to use the Universal Link form of the deep link.
General Format
The general format of a Pulsar deep link is:
pulsar://{action}/{objectType}?parameter1=value1¶meter2=value2Alternatively, you can use:
pulsar://{action}/{objectType}/{objectId}?parameter1=value1¶meter2=value2The braced portions should be replaced with values according to the following rules
{action}: This must be one of the following supported actions: view, edit, update, create, list, quickaction, flow, launchdocument, custom_oath. See the Supported Actions section for more details and examples of each supported action.
{objectType}: This must be a Salesforce object type that you have synced with Pulsar.
{objectId}: This is an optional value that must be a valid Salesforce object ID for the provided object type.
The Salesforce object type is case sensitive. For example, please use WorkOrderLineItem and not workOrderLineItem or workorderlineitem.
Parameters
Pulsar Deep Links have a set of special case-sensitive parameters: Object Selectors and Arguments.
Parameters are also case sensitive!
Object Selectors
Object Selectors are parameters used to search for and select specific objects on which to perform your action.
Id: The Id parameter can be used to specify which object to perform your action on. The value that you choose should match a Salesforce object Id that you have sync’d to your device in Pulsar.
__field: The __field parameter is for indicating a specific field for Pulsar to use as a selector when determining which object we should perform the action on. Specify a field that exists on the object type you provided.
__value: The __value parameter is used in conjunction with the __field parameter. It provides the expected value of the field you’d like to use to find the object you want to perform this action on.
Arguments
Arguments are parameters that alter the behavior of the action.
__show: The __show parameter can be true or false. The default value is false. When set to true, Pulsar will display the resulting object after performing the action. The __show parameter is relevant for edit, update, create, list and possibly quickaction.
__create: The __create parameter can be set to true or false. The default value is false. When set to true, if the provided object location parameters fail to find an object, Pulsar will create a new object for you with the provided parameters and values.
qa: The qa parameter is used specifically with the quickaction action. It defines the quick action to use. This quick action must be present on the object type provided and the context for the quick action will be determined by your object selectors.
flow: The flow parameter is used specifically with the flow action. It defines the flow to execute.
Supported Actions
view
The view Pulsar Deep Link opens a Pulsar page to view an object in display mode. This is equivalent to navigating to the object in Pulsar. Any parameters passed to this action will be used as elements of a search. All parameters passed in must be matched in order to show the object. If more than one match is found, a list view will be presented and you can select the object you wish to view.
The __create argument parameter is available for the view Pulsar Deep Link. If __create is set to true, the object will be created if it is not found using .
view Pulsar Deep Link Example | Description |
|---|---|
pulsar://view/Account/0018c00002ANfAQAA1 | All 3 of these view Pulsar Deep Links navigate to the Account with Id 0018c00002ANfAQAA1in Display mode. They are functionally equivalent. |
pulsar://view/Account?Id=0018c00002ANfAQAA1 | |
pulsar://view/Account?__field=Id&__value=0018c00002ANfAQAA1 | |
pulsar://view/Account?Name=MyAccount | These examples assumes the org does have an Account with Name field = “MyAccount”. These view Pulsar Deep Links navigate to the Account with Name “MyAccount” in Display mode. They are functionally equivalent. |
pulsar://view/Account?__field=Name&__value=MyAccount | |
pulsar://view/Account?Name=DoesNotExist | This example assumes the org does not have an Account with Name field = “DoesNotExist”. An error log will be recorded when this view Pulsar Deep Link is used because there is no Account with Name field = “DoesNotExist”. |
pulsar://view/Account?Name=DoesNotExist&__create=true | This example assumes the org does not have an Account with Name field = “DoesNotExist”. This view Pulsar Deep Link will navigate to a new Account, in create mode, with the Name field populated with “DoesNotExist”. |
edit
The edit Pulsar Deep Link opens a Pulsar page to edit an object. This is equivalent to navigating to the object in Pulsar and tapping the edit button. Any __field and __value parameters passed to this action will be considered changes to be made to the object. Use the object selectors discussed above to target an object for editing. If the object selectors find more than one object, you will be presented with a list of objects to choose from that match the selectors.
edit Pulsar Deep Link Example | Description |
|---|---|
pulsar://edit/Account/0018c00002ANfAQAA1?Description=Edited | All 3 of these edit Pulsar Deep Links are functionally equivalent and navigate to the Account with Id 0018c00002ANfAQAA1, open it in Edit mode with the Description field changed to “Edited”. |
pulsar://edit/Account?Id=0018c00002ANfAQAA1&Description=Edited | |
pulsar://edit/Account?__field=Id&__value=0018c00002ANfAQAA1&Description=Edited | |
pulsar://edit/Account?Name=MyAccount&Description=Edited | This edit Pulsar Deep Link does not use Object Selectors to target a specific Account object, therefore a list of Accounts will be presented. Once an account is chosen, it will be opened in Edit mode with Name field changed to “MyAccount” and Description field changed to “Edited”. |
pulsar://edit/Account?__field=Name&__value=MyAccount&Description=Edited | These examples assumes the org does have an Account with Name field = “MyAccount”. This edit Pulsar Deep Link will use the Object Selectors provided to navigate to the Account with Name “MyAccount” and will open it in Edit mode with the Description field changed to “Edited”. |
pulsar://edit/Account?__field=Name&__value=DoesNotExist | This example assumes the org does not have an Account with Name field = “DoesNotExist”. An error log will be recorded when this edit Pulsar Deep Link is used because there is no Account with Name field = “DoesNotExist”. |
pulsar://edit/Account?__field=Name&__value=DoesNotExist&__create=true | This example assumes the org does not have an Account with Name field = “DoesNotExist”. This edit Pulsar Deep Link will navigate to a new Account with the Name field populated with “DoesNotExist”. |
update
The update Pulsar Deep Link modifies an object determined by the object selectors provided with the changes supplied in the parameters. Unlike the edit Pulsar Deep Link, the update Pulsar Deep Link performs the object update without presenting an edit screen with which to make additional changes.
update Pulsar Deep Link Example | Description |
|---|---|
pulsar://update/Account/0018c00002ANfAQAA1?Description=Edited | All 3 of these edit Pulsar Deep Links are functionally equivalent and navigate to the Account with Id 0018c00002ANfAQAA1, open it in Edit mode with the Description field changed to “Edited”. |
pulsar://update/Account?Id=0018c00002ANfAQAA1&Description=Edited | |
pulsar://update/Account?__field=Id&__value=0018c00002ANfAQAA1&Description=Edited | |
pulsar://edit/Account?Name=MyAccount&Description=Edited | This edit Pulsar Deep Link does not use Object Selectors to target a specific Account object, therefore a list of Accounts will be presented. Once an account is chosen, it will be opened in Edit mode with Name field changed to “MyAccount” and Description field changed to “Edited”. |
pulsar://edit/Account?__field=Name&__value=MyAccount&Description=Edited | This example assumes the org does have an Account with Name field = “MyAccount”. This edit Pulsar Deep Link will use the Object Selectors provided to navigate to the Account with Name “MyAccount” and will open it in Edit mode with the Description field changed to “Edited”. |
pulsar://edit/Account?__field=Name&__value=DoesNotExist | This example assumes the org does not have an Account with Name field = “DoesNotExist”. An error log will be recorded when this edit Pulsar Deep Link is used because there is no Account with Name field = “DoesNotExist”. |
pulsar://edit/Account?__field=Name&__value=DoesNotExist&__create=true | This example assumes the org does not have an Account with Name field = “DoesNotExist”. This edit Pulsar Deep Link will navigate to a new Account with the Name field populated with “DoesNotExist”. |
create
The create Pulsar Deep Link does not use object selectors. All parameters passed to create are used as initial values for the object. Passing no parameters will open a unpopulated create page for an object of the provided object type.
create Pulsar Deep Link Example | Description |
|---|---|
pulsar://create/Account | This create Pulsar Deep Link opens an Account in create mode. All fields will be unpopulated. |
pulsar://create/Account?Description=hello | This create Pulsar Deep Link opens an Account in create mode with the Description field populated with “hello”. |
list
The list Pulsar Deep Link is very similar to the view Pulsar Deep Link. All parameters are used as a filter on the provided object type. All objects which satisfy all the parameter filters are displayed to the user in a list. The list Pulsar Deep Link does not use the __field and __value object selectors.
list Pulsar Deep Link Example | Description |
|---|---|
pulsar://list/Account | This list Pulsar Deep Link opens the Accounts list, displaying all accounts. |
pulsar://list/Account?Name=MyAccount | This example assumes the org does have an Account with Name field = “MyAccount”. This list Pulsar Deep Link opens the Accounts list, displaying accounts with Name field = “MyAccount”. |
pulsar://list/Account?Name=MyAccount&__create=true | This example assumes the org does have an Account with Name field = “MyAccount”. This list Pulsar Deep Link opens the Accounts list, displaying accounts with Name field = “MyAccount”. The __create parameter is ignored in this example because there are accounts that match Name field = “MyAccount”. |
pulsar://list/Account?Name=DoesNotExist&__create=true | This example assumes the org does not have an Account with Name field = “DoesNotExist”. This list Pulsar Deep Link opens an Account in create mode with the Name field populated with “DoesNotExist”. |
quickaction
The quickaction Pulsar Deep Link launches the quick action specified by the special argument qa. The value of this qa parameter must match the QuickActionName (API Name) of a quick action defined on objects of the provided object type. A valid object context must also be determined by the provided object selectors.
quickaction Pulsar Deep Link Example | Description |
|---|---|
pulsar://quickaction/Account/0018c00002ANfAQAA1?qa=NewContact | All 3 of these quickaction Pulsar Deep Links are functionally equivalent and execute the quickaction “NewContact” on the account with Id = “0018c00002ANfAQAA1”. |
pulsar://quickaction/Account?Id=0018c00002ANfAQAA1&qa=NewContact | |
pulsar://quickaction/Account?__field=Id&__value=0018c00002ANfAQAA1&qa=NewContact | |
pulsar://quickaction/Account?Name=MyAccount&qa=NewContact | This example assumes the org does have an Account with Name field = “MyAccount”. This quickaction Pulsar Deep Link will execute the quickaction “NewContact” on the account with Name = “MyAccount”. |
flow
The flow Pulsar Deep Link executes the flow specified by the special argument flow. The value of this flow parameter must match the Flow API Name of a flow defined on objects of the provided object type. A valid object context must also be determined by the provided object selectors.
flow Pulsar Deep Link Example | Description |
|---|---|
pulsar://flow/WorkOrder/0WO6A000001Anr4WAC?flow=Add_Files_Flow_Test | All 3 of these flow Pulsar Deep Links are functionally equivalent and execute the flow “Add_Files_Flow_Test” on the WorkOrder with Id = “0WO6A000001Anr4WAC”. |
pulsar://flow/WorkOrder?Id=0WO6A000001Anr4WAC&flow=Add_Files_Flow_Test | |
pulsar://flow/WorkOrder?__field=Id&__value=0WO6A000001Anr4WAC&flow=Add_Files_Flow_Test | |
pulsar://flow/WorkOrder?WorkOrderNumber=00000004&flow=Add_Files_Flow_Test | This example assumes the org does have a WorkOrder with WorkOrderNumber field = “00000004”. This flow Pulsar Deep Link will execute the flow “Add_Files_Flow_Test” on the WorkOrder with WorkOrderNumber field = “00000004”. |
Note: The flow action is only available in FSL orgs.
launchdocument
The launchdocument Pulsar Deep Link opens a Pulsar page to view the specified document from the Content Library. The Id of the document can be provided as a parameter or as part of the path, but in the case of web content (HTML documents), all parameters will be passed along as URL parameters.
launchdocument Pulsar Deep Link Example | Description |
|---|---|
pulsar://launchdocument/0698c00000AWccoAAD | Both of these launchdocument Pulsar Deep Links are functionally equivalent and open a Pulsar page to view the specified document from the Content Library. |
pulsar://launchdocument?Id=0698c00000AWccoAAD | |
pulsar://launchdocument/0698SomeBadId | This launchdocument Pulsar Deep Link will display an error for the non-existent document. |
pulsar://launchdocument?Id=0698c00000AWccoAAD&extraArg=SomeValue | This launchdocument Pulsar Deep Link will open a Pulsar page to view the specified document from the Content Library while including the “extraArg” parameter and its value |
Note: The launchdocument action works for Content Library documents, but other types of documents (Attachments and Salesforce Files not in the shared Content Libraries) should be opened using the view API.
custom_oauth
The custom_oauth Pulsar Deep Link is used solely as a callback/redirect URI related to external or internal custom OAuth 2.0 flows. Upon receiving this deep link, Pulsar will call any registered custom_oauth handlers. When it is used, any information added to the deep link as a hash fragment or parameters will be passed in the handler, for use by the custom application that set up the handler. For example the following custom javascript application code will use this custom_oauth Pulsar Deep Link behavior.
// register the handler first:
bridge.registerHandler('custom_oauth', function(oauthParams) {
// expecting a token parameter or hash fragment to be appended to the
// deep link that will trigger this function, e.g.
// pulsar://custom_oauth/callback#token=thisismytoken... or
// pulsar://custom_oauth/callback?mytoken=thisismytoken...
// fragment example:
const token = oauthParams['fragment'].split('=')[1];
// parameter example:
const mytoken = oauthParams['mytoken'];
// ...use the token
});
// then, open a window to start the auth flow:
bridge.send(
// request object
{type: 'displayurl',
data: {
fullUrl: "https://authorization-server.com/auth?response_type=code" +
"&client_id=29352735982374239857" +
"&redirect_uri=pulsar://custom_oauth/callback" + // <-- deep link callback
"&scope=create+delete" +
"&state=xcoivjuywkdkhvusuye3kch",
externalBrowser: false, // open inside Pulsar
}
}, // end request object
// callback function
function(responseData) {
if (responseData.type === 'error') {
console.log('An error occurred opening the OAuth endpoint');
}
}
// end callback function
);