Skip to main content

Start Background Task Node

warning

This node is in beta and may not be fully tested or documented. Use with caution.

Kicks off a flow in the background.

Properties

LabelPropertyTypeDescriptionDefault ValueIs Required
Tool NametoolNameOverridebotdojo/types/stringnull
Tool InstructionstoolInstructionsOverridebotdojo/types/stringnull
FlowflowReferencebotdojo/types/flow_reference_selectnull
Create CanvascreateCanvasbotdojo/types/booleanThis will create a canvas so you can watch the execution of the flowfalse
Use Default PropertiesuseDefaultPropertiesbotdojo/types/booleanIf disabled the flow will not use the default properties from the flow.false
Start Task MessagestartJobResponseMessagebotdojo/types/stringThe message to send to the agent when the task is started.
The task with id : {{action.id}} has been started.
Task Completed MessagejobCompletedResponseMessagebotdojo/types/stringThe message to send an agent when the task is completed.
The task with id : {{action.id}} has been completed.
Disable SessiondisableSessionSharingbotdojo/types/booleanBy default, multiple calls to this tool will share its internal state with previous calls. When disabled, each call will start with a fresh state.false
Skip Automatic EvaluationsskipEvaluationsbotdojo/types/booleanWill not run automatic evaluations on the flow if set to automatically runfalse

Output

LabelPropertyTypeDescriptionDefault Value
Tooltoolbotdojo/interface/tooltoolnull