Sign in
workflows

Execute Workflow Registration

Execute Workflow Registration

post/v1/workflows/registrations/{workflow_registration_id}/execute

Path parameters

workflow_registration_idstring uuid required

Request body

execution_idstring nullable

Allows you to specify a custom execution ID. If not provided, a random ID will be generated.

wait_for_resultboolean

If true, wait for the workflow to complete and return the result directly.

timeout_secondsnumber nullable

Maximum time to wait for completion when wait_for_result is true.

custom_tracing_attributesobject nullable
force_new_traceboolean

If true, ignore the caller's trace context and start a new, independent trace for this execution instead of joining the caller's trace.

extensionsobject nullable

Plugin-specific data to propagate into WorkflowContext.extensions at execution time.

task_queuestring nullable

Deprecated. Use deployment_name instead.

deployment_namestring nullable

Name of the deployment to route this execution to

Response

Successful Response

OR

Changes

Changed in 1 of the 3 revisions of this API.1