SOAP API Service Overview
The Adeptia SOAP API Service lets your organization expose integration workflows as SOAP-based web service endpoints, so that external systems and partners can trigger those workflows by sending standard SOAP requests.
What this capability does
When you publish a workflow as a SOAP endpoint, external callers can send SOAP messages to that endpoint to start an integration process. Adeptia receives the inbound message, validates it, routes it to the correct workflow, and either processes it immediately or queues it for background processing, depending on how you configure the interaction.
This capability is useful when you need to accept data from partners, applications, or systems that communicate over SOAP, without requiring those callers to understand the internal structure of your integration workflows.
How it fits into your integrations
The SOAP API Service acts as the entry point for inbound SOAP-driven integrations. Once a SOAP request arrives, Adeptia:
- Confirms the request is directed at a valid workflow of the correct type.
- Extracts the message payload, including any attachments, and prepares it for processing.
- Passes the data into the associated workflow for transformation, routing, or delivery.
This means you can build end-to-end integrations where a partner system sends a SOAP message and Adeptia handles everything that follows, from data mapping to delivery to a target system.
Synchronous and asynchronous processing
A key choice when using the SOAP API Service is whether the caller receives a response immediately or simply receives an acknowledgment that the request was accepted.
| Mode | What the caller receives | When to use it |
|---|---|---|
| Synchronous | A full SOAP response produced by the workflow | When the caller needs a result or confirmation before continuing |
| Asynchronous | A simple acceptance acknowledgment | When the caller does not need to wait for the workflow to complete |
Attachment and binary data support
The SOAP API Service supports inbound messages that carry attachments alongside the main payload. This includes support for MTOM-packaged binary content, where binary data is transmitted efficiently as part of the SOAP message. Adeptia inspects the incoming message, detects whether attachments are present, and stores them appropriately before the workflow begins processing.
Custom SOAP fault responses
When a workflow is configured to return error information, Adeptia can surface that information to the caller as a structured SOAP fault, including a fault description and optional fault detail. This allows the calling system to receive meaningful, standards-compliant error responses rather than generic failures.
What you configure
When setting up a SOAP-triggered workflow, you provide the following:
| What you configure | Purpose |
|---|---|
| The workflow to trigger | Identifies which integration process runs when a SOAP request arrives |
| Synchronous or asynchronous mode | Controls whether the caller waits for a response |
| Security policy | Controls whether callers must authenticate before their requests are accepted |
Context-based routing
The SOAP API Service supports context-based routing, where the content or attributes of the inbound request determine which processing path the workflow follows. When this is configured, the service expects a single attachment per request; sending multiple attachments or no attachment results in an error.