Call a SOAP API

Call SOAP API sends a SOAP envelope through a soap11:Client or soap12:Client connection and returns the response envelope as xml. Like every activity, the call is recorded, so a restart replays the recorded response instead of calling the service again.

Use it to reach the SOAP services that legacy systems still expose, without writing an activity function to wrap the client.

Fields

Field	Required	Description
Connection	Yes	The SOAP client to call through. Both SOAP 1.1 and SOAP 1.2 connections are offered.
Body	Yes	The SOAP envelope, as xml.
Action	For SOAP 1.1	The SOAPAction header. Required for SOAP 1.1 endpoints, optional for SOAP 1.2.
Headers	No	Additional HTTP headers. Under the advanced fields.
Path	No	Path appended to the connection's base URL. Under the advanced fields.
Result	Yes	The variable that receives the response envelope.

Approval Policy, Retry Policy, and Check Error work the same as for every prebuilt activity. See Prebuilt activities.

SOAP 1.1 and SOAP 1.2

The activity accepts either client, and the only difference is Action:

Version	Action
SOAP 1.1	Required. The call fails with an error when it is missing.
SOAP 1.2	Optional, because the action can travel in the content type instead.

Multipart responses

The activity returns xml. An endpoint that answers with a multipart message fails with an error instead. Write your own activity around the SOAP client when you need to read mime:Entity[] payloads.

Next steps

• Call REST API — the same idea for HTTP endpoints.
• Error handling and review activities — what happens when the call keeps failing.
• Activities — write your own activity when the response needs shaping first.