SOAP 1.2 web service
Overview
SOAP (Simple Object Access Protocol) is an XML-based protocol for accessing web services over HTTP.
SOAP allows applications running on different operating systems to communicate using different technologies and programming languages. You can use SOAP APIs to create, retrieve, update or delete records, such as passwords, accounts, leads, and custom objects, from a server.
The SOAP 1.2 Web Service source supports batch syncs.
Info tab
You can find the parameters in the Info tab below (Image 1).
Values
Parameter | Description | Example |
---|---|---|
Title | Mandatory. Input a name for your data sync | SOAP Sync |
Variables | Optional. Review our documentation on Variables here for more information about this field. | |
Permissions | Data syncs are role based access systems where you can give specific groups read, write, execute, and/or all of the above with admin access. Inputting at least an Admin Group is mandatory. |
Source tab
The following table outlines the mandatory and optional parameters you will find on the Source tab (Image 2).
Namespaces
You are required to define every Namespace present in your SOAP request, or in the SOAP response. You must define an envelope schema in the Namespace section. Use the following schema as a default:
Name: soapenv
Value: "http://www.w3.org/2003/05/soap-envelope"
Parameter | Description | Example |
---|---|---|
Namespaces - Name | Name of your SOAP namespace tags in request and response. | "soapenv" |
Namespaces - Value | URL describing this namespace in the response. | "http://schemas.xmlsoap.org/soap/envelope/" |
SOAP 1.2 parameters
Parameter | Description | Example |
---|---|---|
authType | Mandatory. Select the type of authentication you wish to use in this sync: None, WSSE, Basic. | Basic |
Use Password Digest | Use only with WSSE authType and Password Type as PasswordDigest. Otherwise, leave unchecked. | |
Request Timeout | Mandatory. Set a timeout in milliseconds. No maximum value. Minimum greater than 0. Default is 100 milliseconds. | 2000 |
Endpoint | Mandatory. Contains your SOAP 1.2 Web Service API endpoint. | |
Has Mtom Response | Required to be true if SOAP API response contains an attachment outside the message. | |
Record Xpath | Mandatory. The Xpath to select records to extract from the SOAP response. Starts with ‘//’ followed by the tag name. | |
Envelope Namespace | Namespace prefix for SOAP request elements. Make sure the envelope matches the Namespace definition for the envelope. | "soapenv" |
Next steps
Configure your Destination
Define your Sync Actions.
Add in your Post Sync Scripts, if required.
Click Jobs > Start a Job to begin your sync.
Namespace Value
Last updated