Service Connection JSON Definition

Journey Manager includes some services that require connections to external servers to perform their functionality. To learn more about service connections, see Service Connection Overview.

Example

An example Service Connection definition file is shown below.

connection-def.json

{
    "name": "Accounts",
    "type": "HTTP Endpoint",
    "endpoint": "http://api.geonames.org/postalCodeLookupJSON?postalcode=6600&country=AT&username=demo",
    "username": "accounts-user",
    "password": "N876CX281!"
}

Schema

Service Connection definitions must comply with the following schema.

Fields are optional unless otherwise indicated.

Field	Description
name	string Required. The name used to identify the Service Connection.
type	string Required. The connection type. Must be one of the following: "AWS KMS" "AWS S3" "DocuSign" "HTTP Endpoint" "SalesForce" "TIG" "JBoss" "WebLogic" "WebSphere" The following attributes are dependent on the value of this attribute: endpoint, param1, param2, param3, param4.
endpoint	string Dependent on the value of the type attribute. If type is "HTTP Endpoint", this is a URL.
username	string The connection login user name.
password	string The connection login user password.
fileData	Not supported.
param1	string Arbitrary connection parameter 1. The value of this attribute is dependent on the value of the type attribute.
param2	string Arbitrary connection parameter 2. The value of this attribute isdependent on the value of the type attribute.
param3	string Arbitrary connection parameter 3. The value of this attribute is dependent on the value of the type attribute.
param4	string Arbitrary connection parameter 4. The value of this attribute is dependent on the value of the type attribute.