Refresh Server Action — Reference

Notify connected API subscribers that a server action should refresh.

Before you begin

• A Node.js project with Socket.IO configured and connected test clients. Socket-specific operations must run in a socket action.

Refresh Server Action

Notify connected API subscribers that a server action should refresh.

Settings

Setting	Meaning
Name	The step identifier used for results in the server action. Sending/joining steps do not return a delivery receipt merely because they have a name.
Action	The API action whose subscribers should refresh. Select the action through the picker rather than supplying an arbitrary full public URL.
Output	The inspector exposes this switch, but the refresh operation itself does not return a normal result payload or guarantee that clients have finished refreshing.
Input Parameters	Fields generated from the chosen event/action’s $_PARAM definition. Their names and values become the sent parameters. Changing the selected definition clears the earlier parameter mapping; recheck it before testing.

Verification example

After a successful write in a test workflow, choose the list action used by connected pages in Refresh Server Action. Confirm that those subscribed pages reload the intended data. Test an unsubscribed page separately.

Context and delivery limits

This is a refresh notification, not execution of the selected API action as a library call. It emits on the /api namespace and, when configured, attempts to clear corresponding Redis caches. It does not make every browser component reload unless the relevant subscription is in place.

Connect to page behavior

Use client event handlers or the appropriate Server Connect subscription to update the page. Keep authorization, persistence and event delivery as explicit parts of the workflow.

Check your result

You can choose the intended recipients/context and verify the event or room behavior with test clients.