1. Actions
  2. Action Meta

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

optional
boolean

Always displays a clean form when the action is displayed.


execution

optional
object

This object is used to specify details about the execution of the action, such as whether it is a normal or bulk action.


execution.bulk_random_order

optional
boolean

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 systems can handle these actions since order does not matter. 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

optional
boolean

Hides the default message box on the action form.


action_button_label

optional
string

Sets the label of the submit action button.


action_label

optional
string

Sets the label of the action as well as the label of the submit action button.


pre_action_modal.body

optional
string

Displays an alert when the action is loaded.


post_action_modal.body

optional
string

Displays an alert after the action is run. Only works for actions run from the create stub button.


post_action_redirect.link

optional
string

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

optional
string

Sets the title of the message displayed after a form action is run.


post_action_form_message.description

optional
string

Sets the description of the message displayed after a form action is run.


display conditions

optional
array

Conditions that determine if the action is displayed on the actionsmenu block.

NOTE

The action is still available to be run, these conditions only apply to displaying the action in the actionsmenu block.


Simple Settings Examples inside an action

loading...

More complex action meta settings