Nav

Salesforce Marketing Connector Reference

Salesforce Marketing Cloud Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

  • Username Password

  • OAuth Username Password

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances when it sees fit.

Connection Types

Username Password Connection Type

Parameters

Name Type Description Default Value Required

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Auth End Point

String

Endpoint responsible for user authentication. This is the endpoint able to handle SOAP authentication requests.

Read Timeout

Number

Connection Timeout

Number

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

OAuth Username Password Connection Type

Parameters

Name Type Description Default Value Required

OAuth Endpoint

String

x

Soap Endpoint

String

x

Client ID

String

x

Client Secret

String

x

Read Timeout

Number

Connection Timeout

Number

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Associated Operations

  • configureCreate

  • configureDelete

  • configureUpdate

  • create

  • delete

  • performGetMaxCount

  • performStart

  • performStop

  • retrieve

  • scheduleStart

  • update

  • upsert

Operations

Configure Create

<sfdc-marketing-cloud:configure-create>

Operations that allows to create configurations.

Important: When you map your objects to the input of this message processor, match the expected type of the object to the Salesforce Marketing Cloud.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of configuration.

x

Configurations

Array of Object

An array of one or more configurations to be created.

#[payload]

Configure Options

Object

Options to make in the configure operation.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Configure Delete

<sfdc-marketing-cloud:configure-delete>

Operations that allows to delete configurations.

Important: When you map your objects to the input of this message processor, match the expected type of the object to the Salesforce Marketing Cloud.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of configuration.

x

Configurations

Array of Object

An array of one or more configurations to be deleted.

#[payload]

Configure Options

Object

Options to make in the configure operation.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Configure Update

<sfdc-marketing-cloud:configure-update>

Operations that allows to update configurations.

Important: When you map your objects to the input of this message processor, match the expected type of the object to the Salesforce Marketing Cloud.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of configuration.

x

Configurations

Array of Object

An array of one or more configurations to be updated.

#[payload]

Configure Options

Object

Options to make in the configure operation.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Create

<sfdc-marketing-cloud:create>

Creates one or more API objects.

Important: When you map your objects to the input of this message processor, match the expected type of the object to the Salesforce Marketing Cloud.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of API object to create.

x

Api Objects

Array of Object

An array of one or more API Objects.

#[payload]

CreateOptions

Object

Options that can be made on the create operation.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Delete

<sfdc-marketing-cloud:delete>

Deletes one or more API Objects from your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of object to delete.

x

Api Objects

Array of Object

An array of one or more API Objects.

#[payload]

DeleteOptions

Object

Options that can be made on the delete operation.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Perform Get Max Count

<sfdc-marketing-cloud:perform-get-max-count>

Performs a getMaxCount action of the Perform operation and retrieves the number of destinations for the send.

Important: When you map your objects to the input of this message processor, match the expected type of the object to the Salesforce Marketing Cloud.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of object to do a perform on.

x

Definitions

Array of Object

An array of one or more definitions for the perform operation.

#[payload]

Perform Options

Object

Options that can be made on the perform operation with the start GetMaxCount.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Perform Start

<sfdc-marketing-cloud:perform-start>

Performs a start action of the Perform operation.

Important: When you map your objects to the input of this message processor, match the expected type of the object to the Salesforce Marketing Cloud.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of object to do a perform on.

x

Definitions

Array of Object

An array of one or more definitions for the perform operation.

#[payload]

Perform Options

Object

Options that can be made on the perform operation with the start Action.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Perform Stop

<sfdc-marketing-cloud:perform-stop>

Stops an activity that is being performed or stops a scheduled program.

Important: When you map your objects to the input of this message processor, match the expected type of the object to the Salesforce Marketing Cloud.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of object that supports the Stop Action of the Perform Operation.

x

Definitions

Array of Object

An array of one or more definitions for the perform operation.

#[payload]

Perform Options

Object

Options that can be made on the perform operation with the start Action.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Retrieve

<sfdc-marketing-cloud:retrieve>

The Retrieve method enables the retrieval of a single object type. This method retrieves specified object properties only. Filters can be applied to retrieves to ensure that only relevant results are returned. Only the properties that have values for the object are returned. If an object that is requested does not exist, no results are returned.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

Options that can be made on the update operation.

#[payload]

RetrieveOptions

Object

Options that can be made on the update operation.

Streaming Strategy

  • repeatable-in-memory-iterable

  • repeatable-file-store-iterable

  • non-repeatable-iterable

Configure if repeatable streams should be used and their behavior.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Schedule Start

<sfdc-marketing-cloud:schedule-start>

Schedules an action or event to occur at a specific time.

Important: When you map your objects to the input of this message processor, match the expected type of the object to the Salesforce Marketing Cloud.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of object to schedule on.

x

Interactions

Array of Object

An array of one or more interactions in the schedule operation.

#[payload]

Schedule Definitions

Object

A schedule definition used for the schedule operation.

x

Schedule Options

Object

Options that can be made on the schedule operation.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Update

<sfdc-marketing-cloud:update>

Updates one or more API objects.

Important: When you map your objects to the input of this message processor, match the expected type of the object to the Salesforce Marketing Cloud.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of object to update

x

Api Objects

Array of Object

An array of one or more API Objects.

#[payload]

UpdateOptions

Object

Options that can be made on the update operation.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Upsert

<sfdc-marketing-cloud:upsert>

Upserts one or more API objects.

Important: When you map your objects to the input of this message processor, match the expected type of the object to the Salesforce Marketing Cloud.

This operation performs a Create with the SaveAction in the CreateOptions for the fields set to UPDATE_ADD.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of API object to upsert.

x

Api Objects

Array of Object

An array of one or more API Objects.

#[payload]

UpsertOptions

Object

Options that can be made on the upsert operation.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-marketing-cloud-config

Throws

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

  • reconnect

  • reconnect-forever

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in milliseconds) to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in milliseconds) to reconnect.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

This is the maximum amount of instances to keep in memory. If more than that is required, the connector starts to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.

+