> For the complete documentation index, see [llms.txt](https://docs.avonnicomponents.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.avonnicomponents.com/flow/component-builder/interactions-panel/navigate.md).

# Navigate

Send users to a record, an object page, an app, a tab or an external URL when they click an action in an Avonni Flow Screen Component.

## Overview

The Navigate interaction sends the user to another Salesforce page or to an external URL when they click an action. A sales rep clicks **View** on an opportunity row in a Data Table and lands on that opportunity's record page.

<figure><img src="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2F6aa5HytPQpFI99ji1kRx%2Fnavigate-result.png?alt=media" alt="Opportunity record page opened from the View row action of an Avonni Data Table"><figcaption><p>Clicking View on a row opens that opportunity's record page.</p></figcaption></figure>

## Tutorials

Each tutorial builds one Navigate setup in a screen flow, step by step.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Add a New Opportunity button that opens a prefilled record form</strong></td><td>Object Page with New, prefilled fields and a record type choice.</td><td><a href="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FEInTUSqvc19aKoNIktDQ%2Fnavigate-cover-how-to-create-an-interaction-to-navigate-to-an-object.png?alt=media">navigate-cover-how-to-create-an-interaction-to-navigate-to-an-object.png</a></td><td><a href="https://docs.avonnicomponents.com/flow/tutorials/interactions/how-to-create-an-interaction-to-navigate-to-an-object.md">Add a New Opportunity button that opens a prefilled record form</a></td></tr><tr><td><strong>Open a record from a Data Table row</strong></td><td>View, Edit and Clone row actions that open the clicked record.</td><td><a href="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2Fx9JnRR5RZIsNvsRRr9Tc%2Fnavigate-cover-how-to-create-an-interaction-to-a-record-page.png?alt=media">navigate-cover-how-to-create-an-interaction-to-a-record-page.png</a></td><td><a href="https://docs.avonnicomponents.com/flow/tutorials/interactions/how-to-create-an-interaction-to-a-record-page.md">Open a record from a Data Table row</a></td></tr><tr><td><strong>Send users to an external site or another Lightning page</strong></td><td>External URL and its Target, a custom tab, a standard page.</td><td><a href="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FNNuseH9Cj1YberIO01Ci%2Fnavigate-cover-send-users-to-an-external-site-or-another-lightning-page.png?alt=media">navigate-cover-send-users-to-an-external-site-or-another-lightning-page.png</a></td><td><a href="https://docs.avonnicomponents.com/flow/tutorials/interactions/send-users-to-an-external-site-or-another-lightning-page.md">Send users to an external site or another Lightning page</a></td></tr><tr><td><strong>Open records in Console tabs and subtabs</strong></td><td>Workspace tabs, subtabs, focus and tab labels in a console app.</td><td><a href="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FSQOxzBEJkWT15CQ04ZKn%2Fnavigate-cover-open-records-in-console-tabs-and-subtabs.png?alt=media">navigate-cover-open-records-in-console-tabs-and-subtabs.png</a></td><td><a href="https://docs.avonnicomponents.com/flow/tutorials/interactions/open-records-in-console-tabs-and-subtabs.md">Open records in Console tabs and subtabs</a></td></tr></tbody></table>

***

## Quick start

{% stepper %}
{% step %}

### Open the Interactions tab

Select the Avonni component on the screen, click **Open Component Builder**, then open the **Interactions** tab.
{% endstep %}

{% step %}

### Add the interaction to a trigger

Pick the trigger, such as **Row Action** on a Data Table or **Click** on a Button. Add an interaction and set **Type** to **Navigate**.
{% endstep %}

{% step %}

### Match the action with Target Name

When the trigger carries several actions, pick the action that should navigate in **Target Name**, for example **View**. Each action gets its own interaction.
{% endstep %}

{% step %}

### Choose the Page Reference Type

Pick the destination type in **Page Reference Type**. The fields below it change with the type. Use the table in the next section to choose.

<figure><img src="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FAMFM7Vq4W3ioF2N9HJKu%2Fnavigate-panel-record-page.png?alt=media" alt="Navigate interaction set to Record Page on the Row Action trigger of a Data Table" width="320"><figcaption><p>A Navigate interaction on the View row action, set to Record Page.</p></figcaption></figure>
{% endstep %}

{% step %}

### Fill in the fields and test

Fill in the fields for that type, save the flow and run it. Click the action: the destination opens.
{% endstep %}
{% endstepper %}

## Which page reference type?

| Goal                                                    | Page Reference Type                                                     | Key fields                                                    |
| ------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------- |
| Open a record, edit it or clone it                      | [Record Page](#record-page)                                             | **Object Api Name**, **Record Id**, **Action Name**           |
| Open an object's home, a list view or a new record form | [Object Page](#object-page)                                             | **Object Api Name**, **Action Name**                          |
| Show the related list of a parent record                | [Record Relationship Page](#record-relationship-page)                   | **Object Api Name**, **Record Id**, **Relationship Api Name** |
| Open a website outside Salesforce                       | [External URL](#external-url)                                           | **Url**, **Target**                                           |
| Switch to another Lightning app                         | [App](#app)                                                             | **App Target**                                                |
| Open a custom tab                                       | [Navigation Item Page](#navigation-item-page)                           | **Tab Api Name**                                              |
| Open Home, Chatter, Today or a file preview             | [Named Page (Standard)](#named-page-standard)                           | **Page Name**                                                 |
| Open a page of an Experience Builder site               | [Named Page (Experience Builder sites)](#named-page-experience-builder) | **Page Name**, **Parameters**                                 |
| Log the user in or out of a site                        | [Login Page](#login-page)                                               | **Action Name**                                               |
| Open a Knowledge article                                | [Knowledge Article](#knowledge-article)                                 | **Article Type**, **Url Name**                                |
| Open an addressable Lightning component                 | [Lightning Component](#lightning-component)                             | **Component Name**, **Parameters**                            |
| Open a CMS Connect record                               | [External Record Page (CMS Connect pages)](#external-record-page)       | **Record Id**, **Object Info**                                |

<figure><img src="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FuwwSoOxmuozRhMJfnS3e%2Fnavigate-panel-type-picker.png?alt=media" alt="Page Reference Type list of the Navigate interaction, open on External URL" width="320"><figcaption><p>The Page Reference Type list. It scrolls to show the other types.</p></figcaption></figure>

## Target and External URL

Where the destination opens depends on the trigger.

| Trigger                                                                                        | Field shown                                                                                      | Effect                                                                         |
| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| A trigger without a record, such as **Click** on a Button or **Header Action** on a Data Table | **Target** under **Page Reference Type**: **Current Window** (default) or **New Window**         | Applies to every type except **External URL**, which always opens in a new tab |
| A trigger tied to a record, such as **Row Action** on a Data Table                             | **Target** among the **External URL** fields: **New Tab/Window** (default) or **Current Window** | Applies to **External URL** only. The other types open in the current window   |

{% hint style="info" %}
**A Target under Page Reference Type has no effect on External URL.** When the **External URL** fields include their own **Target**, that one decides where the address opens, and it defaults to **New Tab/Window**.
{% endhint %}

## Page reference types

### App

Opens a Lightning app.

| Field          | What to enter                                                               |
| -------------- | --------------------------------------------------------------------------- |
| **App Target** | The app's Id or its developer name, for example `standard__LightningSales`. |

{% hint style="info" %}
To find an app's Id, go to **Setup** > **Apps** > **App Manager**, click **Edit** on the app, and copy the Id from the address bar.
{% endhint %}

The resulting addresses look like this:

| Destination                                    | Address                                               |
| ---------------------------------------------- | ----------------------------------------------------- |
| App home, by Id                                | `/lightning/app/06mRM0000008dNrYAI`                   |
| An object's home in the app, by Id             | `/lightning/app/06mRM0000008dNrYAI/o/Case/home`       |
| App home, by developer name                    | `/lightning/app/standard__LightningSales`             |
| An object's home in the app, by developer name | `/lightning/app/standard__LightningSales/o/Case/home` |

### External Record Page

Listed as **External Record Page (CMS Connect pages)**. Opens a record served by CMS Connect in an Experience Builder site.

| Field           | What to enter                                                                                       |
| --------------- | --------------------------------------------------------------------------------------------------- |
| **Record Id**   | The external record identifier. On a trigger tied to a record, you can pick a field of that record. |
| **Object Info** | **CMS Source Name** and **CMS Type Name** of the record.                                            |

### External URL

Opens an address outside Salesforce.

| Field      | What to enter                                                                                                                                    |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Url**    | The full address, for example `https://www.example.com/pricing`. On a trigger tied to a record, you can pick a URL field of that record.         |
| **Target** | Shown on triggers tied to a record. **New Tab/Window** (default) or **Current Window**. See [Target and External URL](#target-and-external-url). |

### Knowledge Article

Opens a Knowledge article.

| Field            | What to enter                                                             |
| ---------------- | ------------------------------------------------------------------------- |
| **Article Type** | The API name of the article type. Ignored in Experience Builder sites.    |
| **Url Name**     | The value of the article's `UrlName` field, the last part of its address. |

### Lightning Component

Opens a Lightning component as a page.

| Field              | What to enter                                                                                                                                                                                         |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Component Name** | The component in the format `namespace__componentName`, for example `c__accountSummary`. A Lightning web component must be wrapped in an Aura component that implements `lightning:isUrlAddressable`. |
| **Parameters**     | Optional **Name** and **Value** pairs passed to the component.                                                                                                                                        |

### Login Page

Logs the user in or out of an Experience Builder site.

| Field           | What to enter            |
| --------------- | ------------------------ |
| **Action Name** | **Login** or **Logout**. |

### Named Page (Experience Builder) <a href="#named-page-experience-builder" id="named-page-experience-builder"></a>

Listed as **Named Page (Experience Builder sites)**. Opens a page of the site the flow runs in.

| Field          | What to enter                                                                                              |
| -------------- | ---------------------------------------------------------------------------------------------------------- |
| **Page Name**  | The API name of the page, for example `Contact_Support`. Add `__c` for a page named after a custom object. |
| **Parameters** | Optional **Name** and **Value** pairs added to the page address.                                           |

### Named Page (Standard)

Opens a standard Salesforce page.

| Field          | What to enter                                                                  |
| -------------- | ------------------------------------------------------------------------------ |
| **Page Name**  | **Home**, **Chatter**, **Today**, **Data Assessment** or **File Preview**.     |
| **Record Ids** | With **File Preview** only. A comma-separated list of the file Ids to preview. |

### Navigation Item Page

Opens a custom tab: a Lightning page, Visualforce, web or Lightning component tab.

| Field            | What to enter                                                  |
| ---------------- | -------------------------------------------------------------- |
| **Tab Api Name** | The API name of the custom tab, for example `Sales_Dashboard`. |

### Object Page

Opens an object's home, a list view or a new record form.

| Field                     | What to enter                                                                                                                                     |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Object Api Name**       | The API name of the object, for example `Opportunity`. Prefix a managed package object with its namespace.                                        |
| **Action Name**           | **Home**, **List** or **New**.                                                                                                                    |
| **Prefilled Values**      | With **New** only. **Field** and **Value** pairs filled in on the form. **Field** is picked from the object's fields, **Value** is typed as text. |
| **Use Record Type Check** | With **New** only. The user picks a record type before the form opens.                                                                            |

> **Example:** A **New Opportunity** button opens the new opportunity form with **Account** already filled in. [Add a New Opportunity button that opens a prefilled record form](https://docs.avonnicomponents.com/flow/tutorials/interactions/how-to-create-an-interaction-to-navigate-to-an-object.md).

### Record Page

Opens a record in view, edit or clone mode.

| Field               | What to enter                                                                                                          |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **Object Api Name** | The API name of the record's object, for example `Opportunity`.                                                        |
| **Record Id**       | The record's Id. On a trigger tied to a record, pick the record's Id field, shown as **Record: Id** (`{{Record.Id}}`). |
| **Action Name**     | **View**, **Edit** or **Clone**.                                                                                       |

> **Example:** **View** and **Edit** row actions on a Data Table of open opportunities open the clicked opportunity. [Open a record from a Data Table row](https://docs.avonnicomponents.com/flow/tutorials/interactions/how-to-create-an-interaction-to-a-record-page.md).

### Record Relationship Page

Opens the related list of a parent record.

| Field                     | What to enter                                                                |
| ------------------------- | ---------------------------------------------------------------------------- |
| **Object Api Name**       | The API name of the parent object, for example `Account`.                    |
| **Record Id**             | The Id of the parent record.                                                 |
| **Relationship Api Name** | The API name of the relationship, for example `Contacts` or `Opportunities`. |

## Open in a Lightning Console tab <a href="#open-in-a-console-tab" id="open-in-a-console-tab"></a>

In a Lightning Console app, any page reference type can open in a console tab instead of the current page. Outside a console app, a click with **Open Console Tab** on does nothing, so turn it off when the flow also runs in a standard app.

| Field                         | What it does                                                                                                           |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **Open Console Tab**          | Opens the destination in a console workspace tab.                                                                      |
| **Open Console Sub Tab**      | Opens it as a subtab instead.                                                                                          |
| **Parent Tab Id**             | Optional. The tab that receives the subtab. Left empty, the tab the user is on becomes the parent.                     |
| **Record Id**                 | Optional. The record to open in the tab.                                                                               |
| **Url**                       | Optional. A relative or absolute address to open in the tab. A third-party domain must be added as a CSP Trusted Site. |
| **Focus**                     | Shows the tab at once. Off (the default), it opens in the background.                                                  |
| **Override Navigation Rules** | Opens the record as set here even when the app's console navigation rules say otherwise. Tabs only, not subtabs.       |
| **Label**                     | The text on the tab.                                                                                                   |
| **Icon Name**                 | The icon on the tab, for example `standard:opportunity`.                                                               |
| **Icon Alternative Text**     | The text read by screen readers for the icon.                                                                          |

To focus, refresh or close a tab that is already open, use the [Control Console Tab](https://docs.avonnicomponents.com/flow/component-builder/interactions-panel/control-console-tab.md) interaction. Step by step: [Open records in Console tabs and subtabs](https://docs.avonnicomponents.com/flow/tutorials/interactions/open-records-in-console-tabs-and-subtabs.md).

## Examples by component

| Component                                                                          | Trigger                                         | Navigate setup                                                          |
| ---------------------------------------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------------- |
| [Data Table](https://docs.avonnicomponents.com/flow/flow-components/data-table.md) | **Row Action**, **Target Name** **View**        | **Record Page**, `Opportunity`, **Record Id** `{{Record.Id}}`, **View** |
| [Data Table](https://docs.avonnicomponents.com/flow/flow-components/data-table.md) | **Header Action**                               | **Object Page**, `Opportunity`, **New**                                 |
| [Button](https://docs.avonnicomponents.com/flow/flow-components/button.md)         | **Click**                                       | **External URL**, **Url** of the pricing page                           |
| [List](https://docs.avonnicomponents.com/flow/flow-components/list.md)             | **Item Click**                                  | **Record Page**, `Account`, **Record Id** from the item, **View**       |
| [Kanban](https://docs.avonnicomponents.com/flow/flow-components/kanban.md)         | **Item Action Click**, **Target Name** **Edit** | **Record Page**, `Opportunity`, **Record Id** from the card, **Edit**   |
| [Header](https://docs.avonnicomponents.com/flow/flow-components/header.md)         | **Action Click**                                | **Navigation Item Page**, **Tab Api Name** of a dashboard tab           |

## Saved JSON example

Interactions are saved as a JSON array in the interaction attribute of the component. This is a "Navigate" interaction that opens an object page using the exact key names:

```json
[
  {
    "targetName": "goToAccounts",
    "type": "NavigationMixinNavigate",
    "navigationMixinNavigateType": "standard__objectPage",
    "navigationMixinNavigateObjectPageObjectApiName": "Account",
    "navigationMixinNavigateObjectPageActionName": "list"
  }
]
```

* `targetName` is the Target Name of the row or header action that triggers the interaction.
* `type` is the interaction name, `NavigationMixinNavigate`.
* `navigationMixinNavigateType` is the page reference type: `comm__externalRecordPage`, `standard__app`, `comm__loginPage`, `standard__component`, `standard__knowledgeArticlePage`, `comm__namedPage`, `standard__namedPage`, `standard__navItemPage`, `standard__objectPage`, `standard__recordPage`, `standard__recordRelationshipPage` or `standard__webPage`.
* For `standard__objectPage`, `navigationMixinNavigateObjectPageObjectApiName` is the API name of the object and `navigationMixinNavigateObjectPageActionName` is `home`, `list` or `new`.
* For `standard__component`, `navigationMixinNavigateComponentComponentName` is the component name in the format `namespace__componentName`, and `navigationMixinNavigateComponentParameters` holds its parameters.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.avonnicomponents.com/flow/component-builder/interactions-panel/navigate.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
