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
Label | Property | Type | Description | Default Value | Is Required |
---|---|---|---|---|---|
Tool Name | toolNameOverride | botdojo/types/string | null | ||
Tool Instructions | toolInstructionsOverride | botdojo/types/string | null | ||
Flow | flowReference | botdojo/types/flow_reference_select | null | ||
Create Canvas | createCanvas | botdojo/types/boolean | This will create a canvas so you can watch the execution of the flow | false | ✅ |
Use Default Properties | useDefaultProperties | botdojo/types/boolean | If disabled the flow will not use the default properties from the flow. | false | ✅ |
Start Task Message | startJobResponseMessage | botdojo/types/string | The message to send to the agent when the task is started. | ||
The task with id : {{action.id}} has been started. | |||||
✅ | |||||
Task Completed Message | jobCompletedResponseMessage | botdojo/types/string | The message to send an agent when the task is completed. | ||
The task with id : {{action.id}} has been completed. | |||||
✅ | |||||
Disable Session | disableSessionSharing | botdojo/types/boolean | By 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 Evaluations | skipEvaluations | botdojo/types/boolean | Will not run automatic evaluations on the flow if set to automatically run | false | ✅ |
Output
Label | Property | Type | Description | Default Value |
---|---|---|---|---|
Tool | tool | botdojo/interface/tool | tool | null |