> For the complete documentation index, see [llms.txt](https://docs.flexikanban.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flexikanban.ai/references/handlers/navigation-handler-types.md).

# Navigation Handler Types

### Overview

Navigation handler types move the user to a different screen — a Flexi Kanban Form, a Salesforce record, a Lightning Component, a Visualforce page, or any URL. They are configured as the `type` field in a Handler.

See Handlers for the full Handler model and where handlers are configured.

***

### Form

Opens a Flexi Kanban Form built in Form Studio in a modal or panel, directly on the board.

This is the primary way to surface data entry, guided workflows, and structured input without navigating away from the board.

#### Parameters

| Parameter | Required | Description                                                        |
| --------- | -------- | ------------------------------------------------------------------ |
| `formId`  | Yes      | The ID of the Form to open, as configured in Form Studio.          |
| `mode`    | No       | Display mode. Accepted values: `modal`, `panel`. Default: `modal`. |

#### Example

json

```json
{
  "type": "form",
  "config": {
    "formId": "form_qualify_lead",
    "mode": "modal"
  }
}
```

***

### Visualforce Page

Opens a Salesforce Visualforce page.

#### Parameters

| Parameter  | Required | Description                                          |
| ---------- | -------- | ---------------------------------------------------- |
| `pageName` | Yes      | The API name of the Visualforce page to open.        |
| `params`   | No       | JSON object of query parameters to pass to the page. |

#### Example

json

```json
{
  "type": "visualforcePage",
  "config": {
    "pageName": "MyCustomPage",
    "params": {
      "recordId": "{Opportunity.Id}"
    }
  }
}
```

***

### URL

Navigates to any URL. Supports static URLs and dynamic expressions.

#### Parameters

| Parameter | Required | Description                                                              |
| --------- | -------- | ------------------------------------------------------------------------ |
| `url`     | Yes      | The URL to navigate to. Supports merge expressions.                      |
| `target`  | No       | Navigation target. Accepted values: `_self`, `_blank`. Default: `_self`. |

#### Example

json

```json
{
  "type": "url",
  "config": {
    "url": "https://my-portal.example.com/record/{Opportunity.Id}",
    "target": "_blank"
  }
}
```

***

### Lightning Component

Opens a Salesforce Lightning Component.

#### Parameters

| Parameter       | Required | Description                                         |
| --------------- | -------- | --------------------------------------------------- |
| `componentName` | Yes      | The API name of the Lightning Component to open.    |
| `params`        | No       | JSON object of attributes to pass to the component. |

#### Example

json

```json
{
  "type": "lightningComponent",
  "config": {
    "componentName": "c:MyCustomComponent",
    "params": {
      "recordId": "{Opportunity.Id}"
    }
  }
}
```

***

### SObject

Navigates to a Salesforce record page by SObject record ID. Works with any standard or custom object.

#### Parameters

| Parameter  | Required | Description                                                                 |
| ---------- | -------- | --------------------------------------------------------------------------- |
| `recordId` | Yes      | The ID of the Salesforce record to navigate to. Supports merge expressions. |

#### Example

json

```json
{
  "type": "sobject",
  "config": {
    "recordId": "{Opportunity.AccountId}"
  }
}
```

***

### Related Articles

* Handlers
* Form Studio


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.flexikanban.ai/references/handlers/navigation-handler-types.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.