Skip to content

WorkflowPendingRequest

← All HTTP schemas

Represents human input awaited by a workflow run.

Shape: object

Property Required Type Description Rules
runId yes string (uuid) Gets the identifier of the run that produced the request.
requestId yes string Gets the request identifier. Send this value when responding; the resumed execution matches it to the request published with the same id.
portId yes string Gets the identifier of the port that published the request. It maps to a graph node.
requestType no string Gets the request data type name.
responseType no string Gets the expected response type name.
prompt no string Gets the request text shown to the user. For plan approval, this is the plan itself.
form yes WorkflowRequestForm Gets the input field the UI should display.
requestedAt no string (date-time) Gets the UTC time when the request was published.