Contact Free trial Login

Salesforce Marketing Cloud Connector Reference

Version 2.1.2

Configurations


SFDC Marketing Cloud Config

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

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 purges the instances when it sees fit.

Connection Types

Username Password
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

Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0 which means the value used by Fuel SDK is taken.

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0 which means the value used by Fuel SDK is taken.

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
Parameters
Name Type Description Default Value Required

Client ID

String

"Client ID" for your installed package.

x

Client Secret

String

"Client Secret" for your installed package.

x

OAuth Endpoint

String

Endpoint for Identity Provider(IDP) responsible with issuing API Key.

x

Soap Endpoint

String

Endpoint for Service Provider(SP) hosting services to use with issued API Key.

x

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0 which means the value used by Fuel SDK is taken.

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0 which means the value used by Fuel SDK is taken.

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 Sources

Operations

Configure Create

<sfdc-marketing-cloud:configure-create>

Operations that allow creating configurations.

When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at 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 that can be made on the configure operation.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNKNOWN

Configure Delete

<sfdc-marketing-cloud:configure-delete>

Operations that allow deleting configurations.

When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at 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 that can be made on the configure operation.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNKNOWN

Configure Update

<sfdc-marketing-cloud:configure-update>

Operations that allows to update configurations.

When you map your objects to the input of this message processor, keep in mind that they need to match the expected type of the object at 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 that can be made on the configure operation.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNKNOWN

Create

<sfdc-marketing-cloud:create>

Creates one or more API objects.

When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at 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 enabled for the create operation.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNKNOWN

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 enabled for the delete operation.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNKNOWN

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.

When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at 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 to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNKNOWN

Perform Start

<sfdc-marketing-cloud:perform-start>

Performs a start Action of the Perform Operation.

When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at 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 to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNKNOWN

Perform Stop

<sfdc-marketing-cloud:perform-stop>

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

When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at 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 to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNKNOWN

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

Query describing the objects that you want to retrieve.

#[payload]

RetrieveOptions

Object

Options that can be made on the update operation.

Streaming Strategy

Configure if repeatable streams should be used and their behavior.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:UNKNOWN

Schedule Start

<sfdc-marketing-cloud:schedule-start>

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

When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at 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 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 to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNKNOWN

Update

<sfdc-marketing-cloud:update>

Updates one or more API objects.

When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at 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 to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNKNOWN

Upsert

<sfdc-marketing-cloud:upsert>

Upserts one or more API objects.

When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at Salesforce Marketing Cloud. This operation performs 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 to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SFDC-MARKETING-CLOUD:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SFDC-MARKETING-CLOUD:CONNECTIVITY

  • SFDC-MARKETING-CLOUD:UNABLE_TO_FETCH_PAGE

  • SFDC-MARKETING-CLOUD:RETRY_EXHAUSTED

  • SFDC-MARKETING-CLOUD:UNKNOWN

Sources

Modified Object

<sfdc-marketing-cloud:modified-object-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Since

String

Specify a date in the yyyy-MM-ddTHH:mm:ssZ MULE_DATETIME_FORMAT format where Z is the time zone (such as 2019-03-17T16:30:40-03:00) to retrieve the selected objects.

Object Type

String

x

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

Attributes Type

Any

For Configurations

New Object

<sfdc-marketing-cloud:new-object-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Since

String

Specify a date in the yyyy-MM-ddTHH:mm:ssZ MULE_DATETIME_FORMAT format where Z is the time zone (such as 2017-03-17T16:30:40-03:00) to retrieve the selected objects.

Object Type

String

x

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

Attributes Type

Any

For Configurations

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

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.

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message.

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

Object Store

The object store where the redelivery counter for each message is going to be stored.

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of instances that is initially allowed to be kept 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 will be expanded 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 will be expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be 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 will be 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 that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub