Configuring Boomi Agents in EmbedKit

The latest Boomi EmbedKit introduces the ability to run Boomi Agents as a specialized EmbedKit component. This feature lets you create agents in Boomi and make them available to your customers through EmbedKit.

Creating an Agent

To deploy an agent to EmbedKit, you need three process components:

• Agent Router: This component deploys at the parent account level as a Web Server Listener. It routes all inbound agent messages from EmbedKit to Boomi Agentic Flows.
• Sub Account Data Collector: This is a boomi process that acts as a scoped AI Tool to collect data using the credentials collected from the consumer. The data is then passed to the Agent Executor.
• Agent Executor: This component serves as the core processing engine. It deploys as a subprocess at the parent account level and handles all orchestration tasks.

Prerequisites

Before you configure Boomi Agents in EmbedKit, ensure you have:

• Latest Boomi EmbedKit is installed
• Access to a Boomi parent account with appropriate permissions
• Understanding of Boomi process components and shapes
• Familiarity with Web Server Listener configuration in Boomi

Procedure

1. Create a Web Server Listener process at the parent account level in Boomi. This process serves as the router for all agent requests from EmbedKit.

2. Configure the start shape for the Boomi process with the following settings:

   • Operation Type: EXECUTE
   • Object: Agent
   • Expected Input Type: Multipart/form-data
   • Response Output Single JSON Object
   • Response Profile: Use the JSON structure defined in the message format reference section.
   • Attachment Cache: Configure as needed.

3. Add a Branch Shape directly after the start shape listener. Configure the shape with only two branches:

   Branch 1:

   • Add a DataProcess shape with Map Multipart Form Data MIME to JSON set to the Document Cache configured below.
   • Add a Stop and Continue shape.

   Branch 2:

   • Add a Retrieve From Document Cache shape as the first step of the second branch with the following configuration:
     • MIME Property - Name: Static value of body.
   • Add a Set Document Properties shape and create the following properties:
     • MIME Property: Mime Document
     • Dynamic Process Property: sessionId (from the request profile)
     • Dynamic Process Property: message (from the request profile)
     • Dynamic Process Property: integrationPackId (from the request profile)
     • Dynamic Process Property: previousResponseId (from the request profile)
   • Add a new Process Route shape, which serves as the core of the Agent Router:
     • On the General tab, configure two path names: Success and Failure.
     • On the Process Routing tab, provide the mapping between agents (IntegrationPacks) and Agent Executors.

Request and Response profiles message format

The following JSON structure shows the request and response profiles within Boomi:

{
  "sessionId": "9f78c9d0-6f8c-4d11-b2df-6a9f7e6c6a10", 
  "previousResponseId": "some_id",
  "integrationPackId": "SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U3MTk2NTY",
  "agentCommand": "start",
  "parentAccountId": "1234567890",
  "childAccountId": "0987654321",
  "message": {
    "role": "user",
    "type": "json",
    "content": { 
      "data": "JSON DATA HERE",
      "title": "EmbedKit Session Data",
      "html": "<div><h1>EmbedKit Session Data</h1><p>This is an example of HTML content.</p></div>"
    },
    "metadata": {
      "timestamp": "2025-10-30T15:12:45.000Z",
      "platform": "embedkit-ui",
      "language": "en-US"
    }
  }
}