Signal Running Task Asynchronously

Endpoint: POST /api/tasks/{workflowId}/{status}/signal

Updates the task status and output of a Yield task asynchronously. This operation signals a running Yield task and does not wait for the workflow to proceed or return a response. It immediately acknowledges the signal, making it well-suited for high-throughput systems and fire-and-forget scenarios.

Path parameters

Parameter	Description	Type	Required/ Optional
workflowId	The execution ID of the workflow containing the Yield task.	string	Required.
status	The status to which the task is to be updated. Supported values: IN_PROGRESS FAILED FAILED_WITH_TERMINAL_ERROR COMPLETED	string	Required.

Request body

Format the request to include any additional parameters, such as task output data. This data is merged with the existing task output.

Example

{
    "message": "Data processing completed successfully",
    "recordCount": 1540,
    "status": "SUCCESS"
  }

Response

Returns 200 OK, indicating that the task has been signaled successfully. The response only acknowledges the signal and does not reflect task or workflow progression.

Examples

Signal a running task asynchronously

Request

curl -X 'POST' \
  'https://<YOUR-CLUSTER>/api/tasks/fd7s71db5e9c-4a9e-11f0-8f25-26000e13d725/COMPLETED/signal' \
  -H 'accept: */*' \
  -H 'X-Authorization: <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "message": "Data processing completed successfully"
}'

Response

Returns 200 OK, indicating that the task has been signaled successfully.