Actions
Action Meta
Explains action metadata for enabling extra behavior on actions, including AI tool use, webhooks, public forms, and other integration-facing settings.
There are some additional settings that can be assigned to actions to enable extended functionality.
These settings are typically used to enable the action for use by AI (LLMs), 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 nodes.
Actions that run on the bulk nodes 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.
read_only
If this is set to true, any changes made to the stub during the action's execution will not be saved.
This is useful for actions where you want to process or display data without persisting any modifications to the stub.
A good example is a feedback action on a create context — enabling read_only prevents data and attachments from accumulating on the stub indefinitely.
ephemeral_tasks
If this is set to true, the payload of every task in the action is removed from the stubpost once the action has run.
Tasks can still use each other's payloads while the action is running, but none of them are saved on the stubpost. Only the payload is removed, a task's error is still saved.
This is useful for actions that handle sensitive or bulky task results, such as API responses or generated content, that you do not want stored on the stubpost.
To remove the payload of only some tasks, set execution.ephemeral in those tasks' params instead.
This setting is independent of read_only. Set both if you want both behaviors.
Note that if a task saves values from its payload to the stub's data, those values are still saved to the stub, unless the action is also read_only.
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.
enable_chat_routing_stubber_public
Enables the chat routing command for the Stubber public WhatsApp number.
Eg. /chat {my_org_domain} {stubref}
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.
attachment_operations.suppress_attachments
public_form.enable
If enabled, external users can submit data to this action via a unique public URL without authentication.