How to Create a Web Listener in Boomi Integration

A Web Listener in Boomi is an essential component when building real-time integrations, especially for handling inbound HTTP requests from external systems (e.g., webhooks, APIs, or other applications). It acts as a server endpoint that listens for incoming HTTP requests and triggers a Boomi process.

In this article, we’ll walk through step-by-step instructions to create and configure a Web Listener in Boomi.

📌 Prerequisites

Before you begin, make sure you have the following:

• Access to the Boomi AtomSphere platform.
• A deployed Atom (local/cloud) capable of listening for HTTP traffic.
• Basic understanding of Boomi processes and components.

🚀 Step-by-Step Guide

1. Create a New Process

1. Log into Boomi AtomSphere.
2. Navigate to Process and click Create.
3. Enter a Name (e.g., Web Listener Demo).
4. Click Create Process.

2. Set the Start Shape as a Web Services Server (Listener)

1. Drag the Start Shape onto the canvas.
2. Double-click it and choose:

• Connector: Web Services Server
• Connection: Create a new one (see below)
• Operation: Create a new one (see below)

3. Create a Web Services Server Connection

1. In the Connection tab:

• Connector Type: Web Services Server
• Atom: Select your deployed Atom
• Port: Set a unique port (default is 9090; avoid conflicts)
• Path: Set a custom path, e.g., /orderWebhook
• Listener Type: Choose HTTP or HTTPS (based on your need)

🔒 Note: For HTTPS, you’ll need to configure SSL certificates on your Atom.

Click Save and Close.

4. Create a Web Services Server Operation

1. Click +Add Operation:

• Action: POST (or GET, PUT, etc., depending on your API)
• Request Profile: Choose or define a profile (e.g., XML, JSON)
• Response Profile: (optional) Define if your endpoint sends a response back

Click Save and Close.

5. Add a Simple Processing Logic (Optional)

To test the listener, add a Message or Set Properties shape after the Start.

• Use a Message shape to log the inbound payload.
• Optionally, add Decision shapes, Database calls, or Connectors.

6. Deploy the Process

1. Click Deploy > Create Package.
2. Assign to your Runtime Environment (Atom).
3. Click Deploy.

7. Enable Web Service Listener in Atom Management

Go to Manage > Atom Management:

• Select your Atom.
• Under Web Services, ensure your Listener path and port are correctly configured.
• If required, restart the Atom to bind the port.

✅ Testing the Web Listener

Use any HTTP client (like Postman or cURL) to send a request:

bash

Copy

Edit
curl -X POST http://<atom-host>:<port>/<path> 
  -H "Content-Type: application/json" 
  -d '{"sample": "data"}'

Example URL:

bash

Copy

Edit
http://localhost:9090/orderWebhook

Boomi will trigger the process and handle the payload as defined.

🛠 Troubleshooting Tips

IssueFixPort conflictEnsure the port isn’t used by other processesNo responseCheck Atom is running and listening404 ErrorConfirm path and HTTP method match your configSSL errorsEnsure proper SSL certs are set up for HTTPS

📘 Best Practices

• Use authentication headers or API keys if exposing public endpoints.
• Log request metadata (IP, timestamp) for audit purposes.
• Always validate and sanitize input data to prevent security issues.

🔚 Conclusion

Creating a Web Listener in Boomi allows you to build event-driven integrations and receive real-time data from external sources. With careful setup of your listener, request profiles, and deployment, you can establish a reliable endpoint in just minutes.