The HTTP Client Shape is a key component used to invoke external HTTP/REST APIs from within a Boomi process. It’s part of the HTTP Client Connector, which enables outbound HTTP requests (GET, POST, PUT, DELETE) to web services, APIs, or endpoints.
Purpose:
It acts as a “connector” shape in a Boomi process canvas, allowing you to send HTTP requests and handle responses dynamically. It’s ideal for integrating with RESTful services, webhooks, or any HTTP-based endpoint.
Key Capabilities:
- Supports all major HTTP methods.
- Handles authentication (e.g., Basic, OAuth, Client Certificates).
- Processes request/response in formats like JSON, XML, or plain text.
- Integrates with other Boomi shapes (e.g., Map for data transformation, Decision for conditional logic).
When to Use It:
In scenarios like syncing data between apps (e.g., NetSuite to a custom API), calling third-party services, or building synchronous/asynchronous integrations.
How to Use the HTTP Client Shape in a Boomi Process
Create a Connection:
- In your Boomi process, drag the HTTP Client shape onto the canvas.
- Click the Connection field and select “Add a new Connection.”
Configure:
- Base URL: The root endpoint (e.g., https://api.example.com/v1).
- Authentication: Options include None, Basic (username/password), OAuth 1.0/2.0, Custom Headers, or External Provider.
- Advanced: Proxy settings, timeouts, or SSL configurations.
Configure the Operation:
- Select the HTTP method (e.g., POST).
- Set the Resource Path: Relative path (e.g., /users).
- Request Profile: Define headers (e.g., Content-Type: application/JSON), query parameters, or body data.
- Response Profile: Specify expected format (e.g., JSON) for parsing.
- Set the Content Type
Build a Sample Process:
- Start with a Start Shape (e.g., triggered by a timer or incoming data).
- Add a Map Shape to transform input data.
- Insert the HTTP Client Shape to send the request.
- Follow with a Data Process Shape or End Shape to handle the response.