Skip to main content

Callback Out

Returns control from a callback workflow back to the agent.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.

Inputs​

  • Caller ID - (string) Caller ID for correlation, automatically passed from the Callback In node.
  • Result - (object) Optional result to return to the agent. Can be used to pass data back or signal callback completion.

Outputs​

This node does not have outputs (it terminates the callback workflow).

How It Works​

The Callback Out node completes a callback workflow:

  1. Input Reception - Receives the Caller ID from the callback context
  2. Result Processing - Processes the optional Result input
  3. Control Return - Signals the callback simulation to end
  4. Agent Resumption - Returns control to the agent, which continues execution

Common Use Cases​

  • Completing Callbacks - Required to end every callback workflow
  • Returning Data - Pass processed data back to the agent
  • Signaling Completion - Indicate that callback processing is done
  • Error Handling - Return error information to the agent
  • Validation Results - Return validation outcomes

Usage Notes​

  • Required for Callbacks - Every Callback In workflow must end with a Callback Out
  • No Outputs - This is a terminal node with no output connections
  • Result Optional - The Result input is optional; pass an empty string if no result is needed
  • Caller ID Match - The Caller ID must match the one from Callback In
  • Synchronous Return - The agent waits for Callback Out to be reached before continuing
  • Single Return - Each callback workflow should have exactly one Callback Out execution path

Error Handling​

The node will return errors in the following cases:

  • Missing Caller ID - Callback context is not properly set
  • Invalid Caller ID - Caller ID doesn't match an active callback
  • Callback simulation error - Internal error in the callback system

Example Workflows​

Simple Callback:

Callback In → Process Data → Callback Out

Conditional Callback:

Callback In → Check Condition → Branch
  ├─ If True: Process A → Callback Out
  └─ If False: Process B → Callback Out

Logging Callback:

Callback In → Extract Data → Log to Database → Callback Out (empty result)

Validation Callback:

Callback In → Validate Input → Callback Out (validation result)

Result Handling​

The Result input can contain:

  • Empty/Null - No specific result to return
  • String - Simple text result
  • Object - Complex structured data
  • Validation Result - Success/failure indicators
  • Processed Data - Transformed or enhanced data

Best Practices​

  • Always Return - Ensure every execution path leads to a Callback Out
  • Keep Results Simple - Return only necessary data to avoid overhead
  • Error Paths - Include Callback Out in error handling branches
  • Timing - Minimize processing time before Callback Out
  • Clear Results - Use meaningful result structures when returning data

Integration Patterns​

With Callback In:

Callback In
  ↓
[Callback Processing Logic]
  ↓
Callback Out

Multiple Paths:

Callback In
  ↓
Conditional Node
  ├─ Path A → Callback Out
  ├─ Path B → Callback Out
  └─ Path C → Callback Out

Error Handling:

Callback In
  ↓
Try-Catch
  ├─ Success → Callback Out (result)
  └─ Error → Callback Out (error info)

Troubleshooting​

Agent Hangs:

  • Ensure Callback Out is reached in all execution paths
  • Check for infinite loops preventing Callback Out
  • Verify Caller ID is passed correctly

Result Not Used:

  • Not all callback types use the returned result
  • Check if the callback type supports result processing

Callback Errors:

  • Verify Caller ID matches the one from Callback In
  • Check that the callback workflow is properly structured
  • Ensure no other Callback Out has already returned for this Caller ID

Performance Considerations​

  • Synchronous Blocking - The agent waits for Callback Out, so keep processing fast
  • Resource Usage - Minimize resource-intensive operations in callbacks
  • Timeout - Very long callback execution may cause timeouts
  • Result Size - Large results may impact performance