navigate

navigate makes the web widget call the page’s onNavigate handler with a path and query parameters, so your site can route the end user to pricing, a product, or checkout. It renders nothing in the chat and works only in the web widget. The platform never teaches this block: include the syntax in the persona or a skill context, scoped to the widget, which reports pop as its channel. See Response formatting. Verified against lua-cli 3.33.0.

Syntax

::: navigate
![navigate](/pathname?key=value)
:::

Fields

Field	Required	Notes
`/pathname`	Yes	A relative path on your site.
`?key=value`	No	Query parameters, joined with `&`; they arrive parsed in `options.query`.

Example

A reply that sends the end user to the pricing page:

Here is the full pricing breakdown.

::: navigate
![navigate](/pricing?source=chat)
:::

The page receives it through onNavigate:

window.LuaPop.init({
  agentId: "agent_abc123",
  environment: "production",
  onNavigate: (pathname, options) => {
    const query = new URLSearchParams(options.query).toString();
    window.location.href = query ? `${pathname}?${query}` : pathname;
  },
});

The handler receives ("/pricing", { query: { source: "chat" } }). With a router, call it instead of setting location.href. Because navigation is immediate, put a sentence before the block so the jump isn’t a surprise.

Where it renders

Channel	Behavior
Web widget with `onNavigate`	Calls the handler once; nothing is shown
Web widget without `onNavigate`	Dropped; nothing happens
Every other channel	Raw text, so send it only when `Lua.request.channel` is `pop`

Get started

Concepts

Build

Channels

Integrations

Devices

Ship and operate

Marketplace

Build with AI

Examples

Syntax

Fields

Example

Where it renders

See also

​Syntax

​Fields

​Example

​Where it renders

​See also

Syntax

Fields

Example

Where it renders

See also