Tool to update a workflow object in Botpress by setting parameter values. Use when you need to change workflow status, add output data, update tags, or set failure reasons. Any parameters not provided will remain unchanged.
idRequiredstringUnique identifier of the workflow to update (28-36 characters).
tagsobjectKey-value pairs for workflow categorization. Individual keys can be unset by providing empty values. Each value is limited to 500 characters.
botIdRequiredstringUUID of the bot that owns the workflow. This is passed as the x-bot-id header.
outputobjectData returned by the workflow output. Can contain arbitrary JSON structure.
statusstringValid workflow status values.
userIdstringSpecific user ID related to this workflow (28-36 characters).
eventIdstringEvent ID must be specified if the workflow is updated with status 'in_progress'.
timeoutAtstringThe timeout date when the workflow should fail, in ISO 8601 format.
failureReasonstringReason why the workflow failed. Use when status is set to 'failed'.
integrationIdstringOptional integration ID. This is passed as the x-integration-id header.
integrationAliasstringOptional integration alias. This is passed as the x-integration-alias header.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.