Skip to main content

SOAP 1.2 web service (Cinchy Event Triggered)

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​

ParameterDescriptionExample
TitleMandatory. Input a name for your data syncSOAP 1.2 (CDC) to Cinchy
DescriptionOptional. Add in a description for your sync. There is a 500 character limit in thie field.
VariablesOptional. Review our documentation on Variables here for more information about this field.
PermissionsData 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).

Listener Config​

To configure a SOAP 1.2 (Cinchy Event Triggered) connection, you must configure a listener via the Listener Config table. When you create a sync in the table, do the following:

  1. Enter the name of your Listener.
  2. Enter Cinchy CDC under Event Connector Type.
  3. Create your Topic JSON.

For more information, review the Cinchy Event Broker/CDC Listener Configuration values here, and then navigate to the Listener Config table to input a new row.

When setting up your listener configuration for your data sync, keeping the following constraints in mind:

  • Column names in the listener config shouldn't contain spaces. If they do, they will be automatically removed. For example, a column named Companyv Name will become the replacement parameter @CompanyName.
  • The replacement parameter names are case sensitive.
  • Column names in the listener config shouldn't be prefixes of other column names. For example, if you have a column called Name, you shouldn't have another called Name2 as the value of @Name2 may end up being replaced by the value of @Name suffixed with a 2.

Example Listener Configuration​

The example below is an example of a Topic JSON for the Listener Config.

{
  "tableGuid": "420c1851-31ed-4ada-a71b-31659bca6f92",
  "fields": [
    {
      "column": "Cinchy Id",
      "alias": "CinchyId"
    },
    {
      "column": "Company Name",
      "alias": "CompanyName"
    }
  ]
}

Next steps​