pageReference Types

App Type

A standard or custom app available from the App Launcher in an org. Use this pageReference type to create custom navigation components that take users to a specific app or page within the app. Connected apps aren’t supported.

Type

1standard__app

Experience

Lightning Experience

Type Attributes

Property	Type	Description	Required?
appTarget	String	App that you are navigating to. Pass either the appId or appDeveloperName to the appTarget. The appId is the DurableId field on the AppDefinition sObject. The appDeveloperName value is formed by concatenating the app’s namespace with the developer name. To find the app’s developer name, navigate to the App Manager in Setup and look in the Developer Name column. For standard apps, the namespace is standard__. For custom apps, it’s c__. For managed packages, it’s the namespace registered for the package.	Yes
pageRef	PageReference	Identifies a specific location in the app you are navigating to. Pass in the pageRef and applicable attributes for that pageRef type.	No

Example Navigating to an App

1{
2    type: "standard__app",
3    attributes: {
4        appTarget: "standard__Sales",
5    }
6}

Example Navigating to a Record in an App

1{
2    type: "standard__app",
3    attributes: {
4        appTarget: "standard__LightningSales",
5        pageRef: {
6            type: "standard__recordPage",
7            attributes: {
8                recordId: "001xx000003DGg0AAG",
9                objectApiName: "Account",
10                actionName: "view"
11            }
12        }
13    }
14}

URL Format

1/lightning/app/{appTarget}{...pageRef}

URL Format Examples

Navigate to the app’s homepage using the appId

1/lightning/app/06mRM0000008dNrYAI

Navigate to an object record’s page in the app using the appId

1/lightning/app/06mRM0000008dNrYAI/o/Case/home

Navigate to the app’s homepage using the appDeveloperName

1/lightning/app/standard__LightningSales

Navigate to an object record’s page in the app using the appDeveloperName

1/lightning/app/standard__LightningSales/o/Case/home

Lightning Component Type

A Lightning component that implements the lightning:isUrlAddressable interface, which enables the component to be navigated directly via URL.

Type

1standard__component

Experience

Lightning Experience, Salesforce Mobile App

Type Attributes

Property	Type	Description	Required?
componentName	String	The Lightning component name in the format namespace__componentName.	Yes

Example

1{    
2    "type": "standard__component",
3    "attributes": {
4        "componentName": "c__MyLightningComponent"    
5    },    
6    "state": {
7        "myAttr": "attrValue"    
8    }
9}

URL Format

1/cmp/{componentName}?myAttr=attrValue

Login Page Type

An authentication for a community.

Type

1comm__loginPage

Experience

Lightning communities

Type Attributes

Property	Type	Description	Required
actionName	String	A login-related action to be performed. Possible values are: login logout	Yes

You can only navigate to the following

1comm__namedPages

Note

Example

1{
2    type: "comm__loginPage",
3    attributes: {
4        actionName: "login"
5    }
6}

Knowledge Article Page Type

A page that interacts with a Knowledge Article record.

Type

1standard__knowledgeArticlePage

Experience

Lightning Experience, Lightning communities, Salesforce Mobile App

Type Attributes

Property	Type	Description	Required?
articleType	String	The ArticleType API name of the Knowledge Article record. In communities, articleType is ignored.	Yes
urlName	String	The value of the urlName field on the target KnowledgeArticleVersion record. The urlName is the article's URL.	Yes

Example

1{    
2    "type": "standard__knowledgeArticlePage",
3    "attributes": {
4        "articleType": "Briefings",
5        "urlName": "February-2017"
6    }
7}

URL Format

1/articles/{articleType}/{urlName}

URL Format (Communities)

1/article/{urlName}

Named Page Type (Communities)

A standard page in communities with a unique name. If an error occurs, the error view loads and the URL isn’t updated.

Type

1comm__namedPage

Experience

Lightning communities

Type Attributes

Property	Type	Description	Required?
name	String	The unique name of the Lightning community page. The value for name is the API Name value for a supported page. The API Name field can only be defined when a new page is being created, and must be unique. If the API Name isn’t defined upon page creation, it’s automatically generated. The value of home is reserved for the landing page of any community in your org. Supported pages are: Home Account Management Contact Support Error Login My Account Top Articles Topic Catalog Custom pages	Yes

Example

1{
2    type: "comm__namedPage",
3    attributes: {
4        name: "Home"
5    }
6}

URL Format

1/{URL as defined on the community page’s properties}

Named Page Type (Standard)

A standard page with a unique name. If an error occurs, the error view loads and the URL isn’t updated.

Type

1standard__namedPage

Experience

Lightning Experience, Salesforce Mobile App

Type Attributes

Property	Type	Description	Required?
pageName	String	The unique name of the page. Possible values are: home chatter today dataAssessment filePreview	Yes

Example

1{    
2    "type": "standard__namedPage",
3    "attributes": {
4        "pageName": "home"    
5    }
6}

URL Format

1/page/{pageName}

Navigation Item Page Type

A page that displays the content mapped to a CustomTab. Visualforce tabs, web tabs, Lightning Pages, and Lightning Component tabs are supported.

Type

1standard__navItemPage

Experience

Lightning Experience, Salesforce Mobile App

Type Attributes

Property	Type	Description	Required?
apiName	String	The unique name of the CustomTab.	Yes

Example

1{    
2    "type": "standard__navItemPage",
3    "attributes": {
4        "apiName": "MyCustomTabName"    
5    }
6}

URL Format

1/n/{apiName}

Object Page Type

Type

1standard__objectPage

Experience

Lightning Experience, Lightning communities, Salesforce Mobile App

Type Attributes

Property	Type	Description	Required?
actionName	String	The action name to invoke. Valid values include home, list, and new. In communities, list and home are the same.	Yes
objectApiName	String	The API name of the standard or custom object. For custom objects that are part of a managed package, prefix the custom object with ns__.	Yes

State

Property	Type	Description	Supported Actions	Required?
filterName	String	ID or developer name of the object page. Default is Recent.	list	No
defaultFieldValues	String	List of key-value pairs for the default field values that you are passing. This list is generated by the lightning:pageReferenceUtils component. See lightning:pageReferenceUtils for details.	new	No
nooverride	String	To use a standard action, assign this property any value, such as 1. To use an override action, don’t include this property at all.	home, list, new	No

Standard Object Example

1// Opens the case home page.
2{    
3    "type": "standard__objectPage",
4    "attributes": {
5        "objectApiName": "Case",
6        "actionName": "home"
7    }
8}

Navigate to a Specific List View Example

1// Navigates to account list with the filter set to RecentlyViewedAccounts.
2{    
3    "type": "standard__objectPage",
4    "attributes": {
5        "objectApiName": "ns__Widget__c",
6        "actionName": "list"
7    },
8    "state": {
9        "filterName": "RecentlyViewedAccounts"
10  }
11}

Navigate to a Record Create Page with Default Field Values

1// Navigates to a new account object using these default field values.
2//{
3//    Name: "Salesforce, #1=CRM",
4//    OwnerId: "005XXXXXXXXXXXXXXX",
5//    AccountNumber: "ACXXXX",
6//    NumberOfEmployees: 35000,
7//    CustomCheckbox__c: true
8//}
9{
10    type: "standard__objectPage",
11    attributes: {
12        objectApiName: "Account",
13        actionName: "new"
14    },
15    state: {
16        defaultFieldValues = "AccountNumber=ACXXXX,CustomCheckbox__c=true,Name=Salesforce%2C%20%231%3DCRM,NumberOfEmployees=35000,OwnerId=005XXXXXXXXXXXXXXX",
17        nooverride: "1"
18    }
19}

URL Format

1/o/{objectApiName}/{actionName}
2/o/{objectApiName}/{actionName}?filterName=Recent

URL Format (Communities)

1/recordlist/{objectApiName}
2/{baseUrl}/{objectApiName}

Record Page Type

A page that interacts with a record in the org and supports standard actions for that record.

Type

1standard__recordPage

Experience

Lightning Experience, Lightning communities, Salesforce Mobile App

Type Attributes

Property	Type	Description	Required?
actionName	String	The action name to invoke. Valid values include clone, edit, and view. Communities doesn’t support the values clone or edit.	Yes
objectApiName	String	The API name of the record’s object. Optional for lookups.	No
recordId	String	The 18 character record ID.	Yes

State

Property	Type	Description	Required?
nooverride	String	To use a standard action, assign this property any value, such as 1. To use an override action, don’t include this property at all.	No

Example

1{    
2       "type": "standard__recordPage",
3       "attributes": {
4           "recordId": "001xx000003DGg0AAG",
5           "objectApiName": "PersonAccount",
6           "actionName": "view"
7       }
8}

URL Format

1/r/{objectApiName}/{recordId}/{actionName}
2/r/{recordId}/{actionName}

URL Format (Communities)

1/detail/{recordId}
2/{baseUrl}/{recordId}

Record Relationship Page Type

A page that interacts with a relationship on a particular record in the org. Only related lists are supported.

Type

1standard__recordRelationshipPage

Experience

Lightning Experience, Salesforce Mobile App

Type Attributes

Property	Type	Description	Required?
actionName	String	The action name to invoke. Only view is supported.	Yes
objectApiName	String	The API name of the object that defines the relationship. Optional for lookups.	No
recordId	String	The 18 character record ID of the record that defines the relationship.	Yes
relationshipApiName	String	The API name of the object’s relationship field.	Yes

Example

1{    
2    "type": "standard__recordRelationshipPage",
3    "attributes": {
4        "recordId": "500xx000000Ykt4AAC",
5        "objectApiName": "Case",
6        "relationshipApiName": "CaseComments",
7        "actionName": "view"
8    }
9}

URL Format

1/r/{objectApiName}/{recordId}/related/{relationshipApiName}/{actionName}
2/r/{recordId}/related/{relationshipApiName}/{actionName}

URL Format (Communities)

1/relatedlist/{recordId}/{relationshipApiName}
2/{baseUrl}/related/{recordId}/{relationshipApiName}

Web Page

Type

1standard__webPage

Experience

Lightning Experience, Salesforce Mobile App

Attributes

Property	Type	Description	Required
url	String	The URL of the page you are navigating to.	Yes

Example

1{    
2    "type": "standard__webPage",
3    "attributes": {
4        "url": "http://salesforce.com"
5    }
6}

URL Format

A web page opens as is in a new tab, so it doesn’t have a URL format.