Actions Reference

Actions define what happens when an event occurs in a ToolJet application — running a query, displaying an alert, navigating to a different page, updating a variable, and more. They can be configured declaratively through an event handler, or invoked programmatically from a RunJS query.

Run Action

Operate on queries, or surface feedback to the user.

Run Query

Executes a query when triggered.

Reset Query

Resets a query's data and state to default.

Abort Query

Cancels an in-flight query request.

Show Alert

Displays an info, success, warning, or error message.

Control Component

Change a component's state, visibility, or invoke its component-specific actions (CSAs).

Control Component

Invokes a component's own custom action (CSA).

Show Modal

Opens a Modal component on the canvas.

Close Modal

Closes an open Modal component.

Set Table Page

Navigates a Table to a specific page index.

Scroll Component into View

Scrolls a component into the visible viewport.

Navigation

Move the user between pages or apps.

Switch Page

Navigates to another page in a Multipage App.

Go to App

Navigates to a different released app.

Open Web Page

Opens a URL in a new browser tab.

Variable

Create, update, or clear app-level and page-level variables.

Set Page Variable

Sets a variable scoped to the current page.

Unset Page Variable

Clears a single page-scoped variable.

Unset All Page Variable

Clears every variable on the current page.

Set Variable

Sets a variable available across the app.

Unset Variable

Clears a single app-level variable.

Unset All Variable

Clears every variable across the app.

Other

Logout

Logs the current user out of their session.

Generate File

Builds a CSV, text, or PDF file to download.

Set Local Storage

Writes a key-value pair to local storage.

Copy to Clipboard

Copies text to the user's clipboard.

Toggle App Mode

Switches the app's theme between light and dark.