Human in the Loop
Pause workflow execution and wait for human input
Configuration
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
inputFormat | json | No | Input fields for resume |
notification | json | No | Notification tools configuration |
builderData | json | No | Structured response data |
Output
| Parameter | Type | Description |
|---|---|---|
url | string | Resume UI URL |
resumeEndpoint | string | Resume API endpoint URL for direct curl requests |
Usage Instructions
Saves a durable workflow checkpoint and waits for a workspace member with write permission to submit the Resume Form. The current execution layer finishes before pausing; all approval and child-workflow waits at that checkpoint must be satisfied before execution continues. Resumption preserves the original workflow version, execution identity, actor, variables, outputs, and loop/parallel position without replaying completed blocks. Form fields become top-level outputs after resumption. Field names cannot use url, resumeEndpoint, error, stream, execution, response, or JavaScript prototype keys. Review links require authentication; possessing a URL does not grant approval permission. For API review, GET resumeEndpoint to read the current checkpoint, then POST application/json with revision, pausePointId, and input. The server validates the submitted input against the Resume Form. The endpoint is /api/resume/[workflowId]/[executionId] and accepts a user session or API key with access to the workflow workspace. Notification tools run after persistence and can reference this block’s url or resumeEndpoint. Notification failure does not bypass approval. Paused workflows can be cancelled through the job API.
Notes
- Category:
blocks - Type:
human_in_the_loop