Navigation
Overview
A Navigation Action is a special type of Action in Agent Studio that lets the agent move users to the right page in your app. Unlike regular Actions that trigger workflows or APIs, a Navigation Action defines routes (URLs) the agent can open.
Creating a Navigation Action
- Go to Agent Studio → Actions.
- Click Create → Navigation.
- Give your Navigation Action a clear name (e.g.
Orders Navigation
).
You will see two tabs:
- Routes → where you define the allowed URL patterns.
- Evaluations → where you can add test cases (optional).
Defining Routes
Each route is a URL pattern the agent can use.
- URL Pattern
- Must start with
/
. - Supports parameters using
:paramName
.- Example:
/orders/:id
→ matches/orders/42
or/orders/1234
.
- Example:
- Must start with
- Description
- Short label describing what the route is for.
- Example:
Order details page
.
Examples
URL Pattern | Description |
---|---|
/settings/brand | Brand Settings page |
/accounts | Accounts list |
/accounts/:id | Account detail view |
/orders/:id | Order detail view |
Publishing a Navigation Action
- After adding routes, click Publish (top right).
- Publishing makes the Navigation Action available for your agent.
- Versions work the same way as other Actions — you can keep drafts, publish, or roll back to earlier versions.
Best Practices
- Group related routes into one Navigation Action (e.g. all Account routes).
- Use parameters instead of hardcoding many similar URLs.
- Describe routes clearly so teammates can recognize them at a glance.
- Test after publishing: Ask the agent to “Go to my brand settings” and confirm it navigates correctly.
What happens next?
Creating a Navigation Action in Studio defines the routes the agent can use. For navigation to actually work inside your app, a developer must implement a Navigation Handler in the SDK that executes the route change.
Updated 9 days ago