Actions
Action Meta
Additional properties assigned to actions. Can be used to enable AI, webhooks, and more.
There are some additional settings that can be assigned to actions to enable functionality.
These settings are typically used to enable AI, webhooks, and more.
They are set in the action part of the stub definition.
The settings are set in the action_meta
object in the action definition.
Settings
clear_action_data
Always displays a clean form when the action is displayed.
execution
This object is used to specify details about the execution of the action, such as whether it is a normal or bulk action.
Show child attributes
bulk_random_order
If this is set to true
, the action will run on our bulk systems.
Actions that run on the bulk systems do not have a guaranteed order of execution, the upside is that more of these actions can be processed at the same time.
This is useful when you want to run thousands of a specific action and the order that they run in does not matter.
hide_message
Hides the default message box on the action form.
action_button_label
Sets the label of the submit action button.
action_label
Sets the label of the action as well as the label of the submit action button.
pre_action_modal.body
Displays an alert when the action is loaded.
post_action_modal.body
Displays an alert after the action is run. Only works for actions run from the create stub button.
post_action_redirect.link
Redirects the browser to this link after the action is run. Only works for actions run from the create stub button.
post_action_form_message.title
Sets the title of the message displayed after a form action is run.
post_action_form_message.description
Sets the description of the message displayed after a form action is run.
display conditions
Conditions that determine if the action is displayed on the actionsmenu block.
The action is still available to be run, these conditions only apply to displaying the action in the actionsmenu block.