UX - Action

Type identifier: ux:action Category: 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

Output Handles

Configuration Options

Action Type

The node supports four action types:

Navigate Action

Navigates the user to a different location.

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.

Refetch Data Action

Triggers a refetch of data in an Experience.

Download Action

Triggers browser downloads for one or more file outputs.

Download action input:

• files target handle (fixed) receives a single file entry or an array of file entries.

Behaviour

Navigate Action

1. Builds the destination from the navigation target, substituting the input values for the listed variables
2. The user is taken to that destination

Set Data Action

1. Takes the value from the input
2. The datum in the target Experience is set to that value

Refetch Data Action

1. The datum in the target Experience is refetched from its data source

Download Action

1. Accepts either a single file entry or an array of file entries from the files input
2. Each entry must be a file
3. The user's browser downloads each file

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)

Navigate with Parameters

Configuration:

• Action: navigate

• To:

  • Type: url
  • URL: [https://example.com/orders/, { type: "orderId", variable: "orderId" }]
• 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 the file output of an Experience - Pdf - Create node)

Use case: Trigger a PDF download after generation completes.