Actions
Last updated
Last updated
This is the official documentation of the @forestadmin/agent
Node.js agent.
Sooner or later, you will need to perform actions on your data that are specific to your business.
Moderating comments, generating invoices, logging into a customer’s account, or banning users are exactly the kind of important tasks to unlock to manage your day-to-day operations.
To create an Action, you will first need to declare it in your code for a specific collection. Here we declare a "Mark as Live" Action for the companies
collection.
The action behavior is implemented in the execute
function.
scope
require
execute
require
form
optional
description
optional
An optional description of the action. Default: null
submitButtonLabel
optional
A custom label for the submit button. Default: the action name
After declaring it, the Action will appear in the Smart Actions tab within your Collection Settings.
An Action is displayed in the UI only if:
it is set as "visible" (see screenshot below) AND
in non-development environments, the user's role must grant the "trigger" permission
You must make the Action visible there if you wish users to be able to see it in this Team.
Single
, Global
or Bulk
. See for more detail
The callable called when the action is executed, with context
and result builder
as parameters. See and pages for more details.
A list of static fields to be input by the user or a function called with context
as parameters which returns a list of fields. See page for more details.