workflow-resource

Update a workflow state by updating variables or in progress task

Changed on Oct 10, 2026

Updates the workflow variables, tasks and triggers evaluation.

post/api/workflow/{workflowId}/state

Request

Base URL
https://developer.orkescloud.com
Auth
API key in header X-Authorization
TypeScript
https://skmtc.dev/orkescloud/apis/orkes-conductor-api-server/docs/api/workflow/:workflowId/state/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workflowIdstring required

Query parameters

requestIdstring required

waitUntilTaskRefstring

waitForSecondsinteger

Request body

taskReferenceNamestring

variablesobject

Response

blockingTaskIdstring

ID of the blocking task in tasks. Set only for BLOCKING_WORKFLOW responses.

blockingTaskReferenceNamestring

Reference name of the blocking task in tasks. Set only for BLOCKING_WORKFLOW responses.

correlationIdstring

createTimeinteger

createdBystring

inputobject

outputobject

priorityinteger

requestIdstring

responseType'TARGET_WORKFLOW' | 'BLOCKING_WORKFLOW' | 'BLOCKING_TASK' | 'BLOCKING_TASK_INPUT' | 'BLOCKING_TASK_LIST'

Determines whether the response contains a workflow, a task, or a task list.

signalTimeoutboolean

True when the endpoint returned because timeoutMillis elapsed.

targetWorkflowIdstring

ID of the workflow supplied in the signal request.

targetWorkflowStatusstring

Status of the workflow supplied in the signal request.

targetWorkflowVariablesobject

Variables from the workflow supplied in the signal request.

updateTimeinteger

variablesobject

Variables from the workflow represented by this response. This can be a sub-workflow.

workflowIdstring

Changes

Oct 10, 2026a142cbe9d486 Revision changes
- breaking
  the request's body type changed from no type to object
- breaking
  the / request property's minLength was increased from 0 to 1
- breaking
  the / request property's minLength was increased from 0 to 1
- breaking
  the request property type changed from no type to object
- breaking
  the / request property type changed from no type to object
- breaking
  the // request property type changed from no type to object
- breaking
  the / request property type changed from no type to object
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property /// became optional for the status
- warning
  added the new BLOCKING_TASK_LIST enum value to the response property for the response status
- info
  the request property / became optional
- info
  the request property / became optional
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the required property ////// to the response with the status

Operation history