We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.
SOAP (Simple Object Access Protocol) is a messaging protocol specification for exchanging structured information with web services.
The SOAP component supports fetching WSDL definitions, describing the methods a SOAP API supports, and making requests of the API's methods.
Protocol Specification
This component implements SOAP as defined in the W3C SOAP specification.
Connections
Basic Authentication
SOAP Basic Authentication uses a username and password along with a SOAP login method to authenticate API requests.
Prerequisites
- Access to a SOAP API that supports Basic Authentication
- A valid username and password for the SOAP service
- Knowledge of the SOAP login method name required by the API
Configure the Connection
- Username: Enter the username for the SOAP API
- Password: Enter the password for the SOAP API
- SOAP Login Method: Enter the method name used to authenticate with the SOAP API (e.g.,
Login) - WSDL Definition URL: Enter the URL to retrieve the WSDL definition from (optional, e.g.,
https://example.com/api.svc?WSDL)
| Input | Comments | Default |
|---|---|---|
| Username | Username | |
| Password | Password | |
| SOAP Login Method | The method used to authenticate the SOAP API. | |
| WSDL Definition URL | An optional URL to retrieve a WSDL definition from |
Actions
Describe Client
Description of services, ports and methods as a JavaScript object
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| WSDL Definition | The WSDL definition's raw XML in string format |
Get Authentication
Retrieve authentication data from a SOAP endpoint by calling the specified authentication method
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| WSDL Definition | The WSDL definition's raw XML in string format |
Get WSDL Definition
Retrieves a WSDL Definition from a given endpoint and returns the raw XML
| Input | Comments | Default |
|---|---|---|
| WSDL URL | The URL of the WSDL |
Request
Makes a request to the SOAP webservice using the specified method
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| WSDL Definition | The WSDL definition's raw XML in string format | |
| Method | Execute the SOAP web service method | |
| SOAP URL Override | Optionally override the default web service URL defined in the WSDL | |
| Request Headers | Blocks of XML to include in the SOAP header of the request | |
| SOAP Parameters | Any additional parameters to pass to the web service method |