UX - Action
Type identifier:
ux:actionCategory: UX Operations
Description
The UX - Action node triggers actions in the user interface of an Experience. It can navigate to different pages or Experiences, update data in the UI, trigger data refetches, or trigger file downloads. This enables Flows to control the user experience dynamically.
Input Handles
Handle | Data Type | Description |
|---|---|---|
| control | Triggers the action. |
| varies | Optional value or Record ID for set-data, refetch-data, and Entity navigation. |
| file | Required file entry or array for downloads. |
| varies | Dynamic handles for URL variables and Experience datum inputs. Referenced inputs are required. |
Output Handles
Handle | Data Type | Description |
|---|---|---|
| control | Triggered after the action runs. |
Configuration Options
Action Type
The node supports four action types:
Navigate Action
Navigates the user to a different location.
Option | Type | Description |
|---|---|---|
To | navigation target | Destination for navigation. |
Variables |
| Variables for the target URL. |
Navigation targets:
- URL: Navigate to an absolute URL
- Experience: Navigate to another Experience in the Space
- Path: Navigate to a relative path
- Entity: Navigate to a Record detail view
Set Data Action
Updates a datum value in an Experience.
Option | Type | Description |
|---|---|---|
Experience |
| Target Experience. |
Datum | reference | The datum to update. |
Refetch Data Action
Triggers a refetch of data in an Experience.
Option | Type | Description |
|---|---|---|
Experience |
| Target Experience. |
Datum | reference | The datum to refetch. |
Download Action
Triggers browser downloads for one or more file outputs.
Download action input:
filestarget handle (fixed) receives a single file entry or an array of file entries.
Behaviour
Navigate Action
- Builds the destination from the navigation target, substituting the input values for the listed variables
- The user is taken to that destination
Set Data Action
- Takes the value from the input
- The datum in the target Experience is set to that value
Refetch Data Action
- The Schema of the datum in the target Experience is looked up. The datum can be an entity context or a query, including a query that selects columns or groups rows; a query's Schema is the Schema it queries.
- In the Experience that started the Flow, every list and query over that Schema reloads, including queries that select columns or group rows (for example totals per column). When the
datainput holds a Record ID, that Record reloads too.
Download Action
- Accepts either a single file entry or an array of file entries from the
filesinput - Each entry must be a file
- The user's browser downloads each file
Files created by a Flow run can be downloaded by the user who started that run, including built-in USER members and guest or magic-link sessions, while they can still run the Flow, and by Space admins. Other users get a not-found response.
Output Format
Navigate output:
{
"type": "ux:action",
"action": "navigate",
"to": {
"type": "url",
"url": "https://example.com/page"
}
}Set data output:
{
"type": "ux:action",
"action": "set-data",
"experienceId": "...",
"datumReference": { ... },
"value": { ... }
}Download output:
{
"type": "ux:action",
"action": "download",
"files": [
{
"id": "file_123",
"name": "report.pdf",
"mimeTypeId": "pdf",
"size": 104857,
"spaceId": "sp_123",
"schemaId": "schema_123",
"entityId": "entity_123"
}
]
}Examples
Navigate to Experience
Configuration:
- Action:
navigate To:
- Type:
experience - Experience: (target Experience)
- Type:
Navigate with Parameters
Configuration:
- Action:
navigate To:
- Type:
url - URL: [
https://example.com/orders/, { type: "orderId", variable: "orderId" }]
- Type:
- Variables:
["orderId"]
Input:
orderId: "order-123"
Result: Navigates to https://example.com/orders/order-123
Update Form State
Configuration:
- Action:
set-data - Experience: (form Experience)
- Datum: (selected item datum)
Input:
data: The item to select
Refresh Data List
Configuration:
- Action:
refetch-data - Experience: (list Experience)
- Datum: (items query datum)
Use case: Refresh a list after creating a new item.
Download a Generated PDF
Configuration:
- Action:
download
Input:
files: output from an upstream file-producing node (for example thefileoutput of an Experience - Pdf - Create node)
Use case: Trigger a PDF download after generation completes.