Help Centre › Building Processes
This article describes the RPA HTTP functionality to send a SOAP request.
For a full list of available functions, please read HTTP functions.
Description
The Send SOAP request function sends a SOAP request with a raw XML envelope to a SOAP web service endpoint and parses the XML response. This is useful for integrating with legacy enterprise services that use SOAP/WSDL.
Setting it up
To use the Send SOAP request function, follow these instructions:
{{popups:rpas/add:action=api-soap}}
Once on a process map:
- Navigate to the process where you would like to add the Send SOAP request function
- Click on the green button's drop-down (right side of the green button labelled "Process")
- On the menu that appears, click on the "+ Activity" item
- From here you can select the Send SOAP request option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Name | No | Text | - | The alias of a previously created session (from api-session) |
| URL | Yes | Text | - | The SOAP endpoint URL |
| Action | No | Text | - | The SOAPAction header value (required by some WSDL definitions) |
| Envelope | Yes | Text | - | The raw XML SOAP envelope to send |
| Headers | No | JSON | - | Additional headers for this request |
| Timeout | No | Number | - | Request timeout in seconds |
| Variable | No | Text | response | Variable name to store the response |
Output variables
| Variable | Type | Description |
|---|---|---|
| {response} | Object | The response object with the parsed XML body |
Errors
| Error | Description |
|---|---|
| Connection failed | Unable to establish a connection to the SOAP endpoint |
| Invalid XML | The envelope is not valid XML |
| SOAP fault | The SOAP service returned a fault response |
Tips
- Set the SOAPAction header when required by the WSDL definition
- Use variables in the envelope XML for dynamic values (e.g. {invoice_number})
- Check the WSDL documentation for the correct envelope structure