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

{
  "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

{
  "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

{
  "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

{
  "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

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

---

Related Articles

• Handlers

• Form Studio