SOAP API

The SOAP API action allows you to call an external SOAP web service from your form, send a request, and process the response. This is useful for integrating your workflow with external systems, exchanging data, or triggering remote operations.

Properties and Explanation

SOAP Version: Select the SOAP protocol version to use for the request. Options include Version 1.1 and Version 1.2.

URL: Enter the endpoint URL of the SOAP web service you want to call.

Namespace: Specify the XML namespace for the SOAP request. This is required by many SOAP services to identify the target operation.

Namespace URL: Provide the URL associated with the namespace, if required by the service.

Task: Enter the name of the SOAP operation or task to be performed.

Request: Define the SOAP request body. You can use the Formula Editor to dynamically generate the request XML based on form data or context.

Response: Specify how to handle the SOAP response. You can use the Formula Editor to process or extract values from the response.

Successful Message: Set a message to display when the SOAP call is successful. This can be a static message or generated dynamically using the Formula Editor.

Stop Process From Changing State: If checked, the process will not advance to the next state after the SOAP call. Use this to halt workflow progression based on the SOAP response or error.

• The action sends the request, processes the response, and can update form fields or display messages based on the result.

• You can use formulas to dynamically build requests and handle responses, enabling flexible integration scenarios.

Full Configuration Example

Below is a screenshot of the SOAP API action configuration, showing all properties set for SOAP version, URL, namespace, request, response, and process control:

• In this example, the action is configured to call a SOAP service, send a request, and handle the response, with options to display messages and control workflow progression.

• When the action is triggered, the SOAP call is made and the form is updated according to your configuration.