SOAP Request icon

SOAP Request

SOAP Request
Join our community

Overview

This node performs SOAP API requests, allowing users to send custom SOAP envelopes to specified endpoints. It supports various HTTP methods (GET, POST, PUT, DELETE, etc.) and can include optional SOAP headers. The node is useful for integrating with legacy or enterprise systems that expose SOAP web services, enabling automation workflows to interact with these services directly.

Typical use cases include:

  • Sending a SOAP request to query or update data on an external system.
  • Automating interactions with SOAP-based APIs in business processes.
  • Converting SOAP responses into JSON for easier downstream processing.

For example, a user might configure the node to send a POST request with a specific SOAP body to a CRM system's SOAP endpoint, optionally including authentication headers, and then parse the response as JSON for further workflow steps.

Properties

Name Meaning
Authentication Selects the authentication method: None or SOAP API Credential Type (requires credentials).
SOAP Api Credentials The credentials used for authenticating with the SOAP API (shown only if SOAP API Credential Type chosen).
Method The HTTP method to use for the SOAP request. Options: DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT.
URL The full URL of the SOAP endpoint to which the request will be sent.
Send Headers Boolean flag indicating whether to include a SOAP header section in the request.
Headers The SOAP headers content as a string (only shown if "Send Headers" is true).
Body The SOAP body content as a string. This is the main payload of the SOAP request.
Convert Response to Json Whether to convert the SOAP XML response body into JSON format for easier consumption.

Output

The node outputs an array of JSON objects, each containing:

  • data: The main content of the SOAP response extracted from the <soap:Body> element. This is either a raw XML string or a parsed JSON object if conversion was enabled.
  • headers: The HTTP response headers returned by the SOAP endpoint.
  • statusCode: The HTTP status code of the response.
  • statusMessage: The HTTP status message associated with the status code.

If the "Convert Response to Json" option is enabled, the SOAP XML response inside the body is parsed into a JSON object, simplifying access to nested elements.

The node does not output binary data.

Dependencies

  • Requires an active internet connection to reach the specified SOAP endpoint.
  • Supports optional authentication via SOAP API credentials (an API key or token).
  • Uses internal libraries for XML parsing (@xmldom/xmldom), XPath querying (xpath), and XML-to-JSON conversion (xml2js).
  • No additional environment variables are required beyond the configured credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing SOAP endpoint URL will cause request failures.
    • Incorrect SOAP body or headers may result in server errors or unexpected responses.
    • Authentication failures if credentials are incorrect or missing when required.
    • Enabling JSON conversion on non-standard or malformed XML responses may cause parsing errors.

  • Error messages:

    • Network errors or timeouts indicate connectivity issues or unreachable endpoints.
    • HTTP error codes (4xx, 5xx) reflect problems with the request or server; check URL, method, headers, and body.
    • XML parsing errors suggest invalid SOAP responses; verify the SOAP service is returning well-formed XML.

To resolve issues:

  • Double-check the URL and HTTP method.
  • Validate the SOAP body and headers against the target service’s WSDL or documentation.
  • Ensure credentials are correctly set if authentication is enabled.
  • Disable JSON conversion to inspect raw XML responses if parsing fails.

Links and References

Discussion