navigate embed event - Omni Docs

Content and/or connection permissions are not automatically provided to the user during a navigate event. This means if you redirect a user to a dashboard or workbook, the user will need the appropriate content and/or connection permissions to view the content.

{
  "name": "navigate",
  "payload": {
    "path": "string"
  }
}

Properties

string

The path to redirect to.

Navigate to a dashboard

When the navigation arrives at a dashboard, Omni emits the dashboard:ready event. Omni also emits this event when the path is the dashboard that is already shown. A navigate event changes how Omni handles dashboard:filter-change-by-url-parameter events:

Omni discards the filters that wait for the page the user leaves
Omni applies a filter that you send after the navigate event to the dashboard where the navigation arrives

Example

{
  "name": "navigate",
  "payload": {
    "path": "/dashboards/abcd1234"
  }
}