Overview
This node sends SOAP requests to a specified web service using its WSDL URL. It allows users to call any method exposed by the SOAP service, passing custom arguments and client options. This is useful for integrating with legacy systems or services that expose SOAP APIs, such as enterprise applications, payment gateways, or CRM systems.
Typical use cases include:
- Fetching data from a SOAP-based API by calling specific methods.
- Sending commands or updates to a SOAP service.
- Automating workflows that require interaction with SOAP endpoints.
For example, you might use this node to call a "GetOrders" method on an order management SOAP service, passing filter parameters in the request arguments.
Properties
| Name | Meaning |
|---|---|
| WSDL Url | The URL of the WSDL (Web Services Description Language) file describing the SOAP service. Example: https://example.org/service.asmx?WSDL |
| Method | The name of the SOAP method to call on the service. Example: GetOrders |
| Request Arguments | JSON object representing the arguments to pass to the SOAP method. These generate the XML inside the SOAP Body section. See soap package docs for details. Default is {}. |
| Client Options | JSON object with additional options for creating the SOAP client, such as HTTP headers or security settings. See soap package docs for details. Default is {}. |
Output
The node outputs an array of JSON objects under the json field. Each object corresponds to one input item and contains a single property:
result: The response returned by the SOAP service method call. This is typically a parsed JSON representation of the SOAP response XML.
No binary data output is produced by this node.
Dependencies
- Requires access to the SOAP service endpoint described by the provided WSDL URL.
- Uses the external
soapnpm package to create clients and make SOAP calls. - No special n8n credentials are required, but if the SOAP service requires authentication, it must be handled via the client options or within the WSDL URL.
Troubleshooting
- Invalid WSDL URL or unreachable service: Ensure the WSDL URL is correct and accessible from the n8n environment.
- Incorrect method name: Verify the method name matches exactly one of the operations defined in the WSDL.
- Malformed request arguments: The
Request Argumentsmust be valid JSON and conform to the expected structure for the SOAP method. - Client options misconfiguration: Incorrect client options may cause connection or authentication failures.
- Timeouts or network errors: Check network connectivity and service availability.
Common error messages will originate from the underlying SOAP client library and usually indicate issues like connection failure, invalid method, or malformed XML. Reviewing the exact error message and verifying inputs usually resolves these problems.