Send a Response to an AI Agent with a Callback

When an AI agent invokes an asynchronous integration registered as an agentic AI tool, the agentic AI tool must send the response through a callback when it completes. To send a response to the AI agent, add the AI Agent action in your integration and configure the operation Callback AI agent.

Applies to agentic AI tools that do not call Human in the loop. Callback is automatically implemented for Human in the loop. See Design an Integration to Call a Workflow.

How Callback Works

An AI agent can have any number of asynchronous tools in its list of tools. When the AI agent invokes an asynchronous agentic AI tool, it stops reasoning. You'll see the AI agent status Waiting for tool to process. The AI agent resumes reasoning only after it receives a response through the callback.

Example:

You have an AI agent that calls an asynchronous agentic AI tool. You have an asynchronous integration registered as the agentic AI tool. You also have a callback integration with the Callback AI agent action configured to send the response back to the AI agent.

Here's a summary of what happens:

1. The AI agent invokes the asynchronous integration registered as an agentic AI tool. The AI agent waits for the response to be sent through the callback.
2. The asynchronous integration calls an external application to perform an operation.
3. The external application completes the operation, and invokes the callback integration to send the response back to the AI agent.
4. When the AI agent receives the response, it continues reasoning.

For a detailed walk through of how callback works with an AI agent and agentic AI tool, see: Use Case: Send a Callback to an AI Agent for an Asynchronous Tool

Response to the AI Agent

The integration that implements the callback to the AI Agent must pass these parameters:

{
  "toolFlowId": "",
  "conversationId": "",
  "toolInstanceId": "",  
  "responsePayload": "",
}

Add a Callback to an AI agent

1. Add an AI Agent action to an integration in either of the following ways:
   • On the side of the canvas, click Actions and drag to the appropriate location.
   • Click at the location where you want to add the action, type AI, then select AI Agent.
   
   

   

   
   
2. Configure the AI agent callback details.
   1. In Configure Basic Info, configure fields for your AI agent, then click Continue:
      • What do you want to call your endpoint: Required. Enter a meaningful name that reflects the business function of the call such as CallbacktoAgent.
      • What does this endpoint do: Optional description. For example: Sends the response to the AI agent.
      • Action: Select Callback AI agent. .
   2. In Configuration, select the current project or any shared project in which your AI agent resides, and the AI agent to which you want to send the response, then click Continue.

      Note:

      Only AI agents with the Active status are displayed for selection.
   3. In Summary, click Finish to complete configuring the AI agent callback in your integration.
      A map is automatically created.
3. Configure mapping for your AI agent.
   1. Configure parameters and values to implement callback to your AI agent.
      
      

      

      
      

      Parameter	Description	How to get the value
      Project Id	Optional. Use to specify a different project than selected in the configuration wizard. Current project or shared project in which the AI agent resides.	View a project's identifier in the project details page when you edit the project details. See Edit Project Description Details
      Agent Id	Optional. Use to specify a different AI agent than selected in the configuration wizard. ID of the AI agent to which to send the response. This is the AI agent that invoked the agentic AI tool.	View the AI agent identifier in the Test Agent page when you run the AI agent.
      Conversation Id	Required. ID of the conversation in which the agentic AI tool was invoked. When an AI agent runs, a conversation ID is automatically generated by default, unless you specify the conversation ID. The conversation ID can span multiple instance IDs.	You can view the conversation ID when you run an AI agent. See Get the conversation ID
      Tool Flow Id	Required. Tool instance ID at runtime.	You can see the instance ID of a tool by selecting Integrations from the left navigation pane, then Observe, then Instances. You can copy the tool instance ID from the Instance ID column for the integration for the agentic AI tool.
      Tool Invoke Event Id	Required. Same as Tool Flow ID.	Use the instance ID for both Tool Flow ID and Tool Invoke Event ID.
      Payload	Required. Payload that you want to send to the AI agent in the callback. The payload can be any stringified JSON. Can be any custom JSON, there is no strict format.	You pass any payload that you require.

   2. When mapping is complete, click Validate.
   3. Click Back to return to the Integration canvas.
   4. Click Save.
4. Activate the integration.

   See Activate an integration.