END Node

Documentation Index

Fetch the complete documentation index at: https://hypha-docs.plinqx.app/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

• Defines Output Schema: JSON Schema specifying return structure
• Returns Data: What the flow returns to callers
• Validates Output: Ensures return data matches the schema
• Completes Flow: Signals successful flow completion

​

Output Schema

• JSON Schema Format: Standard JSON Schema specification
• Type Validation: Validates return types
• Structure: Defines the shape of returned data

​

Example Output Schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Whether operation succeeded"
    },
    "result": {
      "type": "object",
      "description": "Operation result"
    },
    "message": {
      "type": "string",
      "description": "Status message"
    }
  },
  "required": ["success"]
}

​

Return Value

• Expression-Based: Use expressions to construct return value
• Variable References: Reference data from any previous node
• Transformations: Apply transformations before returning

​

Example Return Value

{
  "success": true,
  "result": "{{action_step.response}}",
  "message": "Operation completed successfully"
}

​

Response Modes

​

Sync Mode

• Immediate Return: Returns data directly to caller
• Timeout: Must complete within timeout window
• Use Case: When caller needs immediate result

​

Async Mode

• Acknowledgment: Returns acknowledgment immediately
• Result Available: Result available via flow run API
• Use Case: Long-running flows, fire-and-forget

​

Error Handling

• Error Response: Error details returned to caller
• No Output: END node output not returned
• Error Logging: Errors logged in flow execution history

​

Best Practices

​

Next Steps