Salesforce Marketing Cloud Connector Reference - Mule 4
Salesforce Marketing Cloud Connector v3.0
Release Notes: Salesforce Marketing Cloud Connector Release Notes
Configurations
Default Configuration
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 to provide to this configuration. |
x |
||
Read timeout |
Number |
Specifies the amount of time, in the unit defined in Service URL, that the consumer waits for a response before it times out. |
0 |
|
Read timeout time unit |
Enumeration, one of:
|
A time unit that qualifies the Read timeout. |
SECONDS |
|
Name |
String |
The identifier of this element used to reference it in other components. |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
Connection Types
Basic Authentication
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Service URL |
String |
The base URL of the service on Salesforce Marketing Cloud to be accessed from the connector. From this base URL all other endpoints derive. |
x |
|
Connection Timeout |
Number |
The socket connection timeout value. This attribute works in tandem with Connection Timeout Unit. |
||
Connection Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Connection Timeout. |
SECONDS |
|
Proxy configuration |
Proxy configuration for the connector. |
|||
WSDL file URL |
String |
The URL of the WSDL file used by this connector. When no value is set, this parameter defaults to the Service URL parameter host, but it appends /etframework.wsdl at its end. |
||
Username |
String |
Username used to initialize the session. |
x |
|
Password |
String |
Password used to authenticate the user. |
x |
|
TLS configuration |
Protocol to use for communication. Valid values are HTTP and HTTPS. Default value is HTTP. When using HTTPS, the HTTP communication is secured using TLS / SSL. If HTTPS was configured as the protocol, the user needs to configure the keystore in the tls:context child element of this listener-config. |
|||
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 Client Credentials
Parameters
| Connection Timeout | Type | Description | Default Value | Required |
|---|---|---|---|---|
Service URL |
String |
The base URL of the service on Salesforce Marketing Cloud to be accessed from the connector. From this base URL all other endpoints derive. |
x |
|
Connection Timeout |
Number |
The socket connection timeout value. This attribute works in tandem with the Connection Timeout Unit. |
||
Connection Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Connection Timeout. |
SECONDS |
|
Proxy configuration |
Proxy configuration for the connector. |
|||
WSDL file URL |
String |
The URL of the WSDL file used by this connector. When no value is set, this parameter defaults to the Service URL parameter host, but it appends /etframework.wsdl at its end. |
||
TLS configuration |
Protocol to use for communication. Valid values are HTTP and HTTPS. Default value is HTTP. When using HTTPS, the HTTP communication is secured using TLS / SSL. If HTTPS was configured as the protocol, the user needs to configure at least the keystore in the tls:context child element of this listener-config. |
|||
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. |
|||
Client Id |
String |
The OAuth client ID as registered with the service provider. |
x |
|
Client Secret |
String |
The OAuth client secret as registered with the service provider. |
x |
|
Token Url |
String |
The service provider’s token endpoint URL. |
||
Scopes |
String |
The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation. |
||
Object Store |
String |
A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime will automatically provision the default one. |
Configure action
<sfdc-marketing-cloud:configure>
Operation that allows the configuration of actions. IMPORTANT: When you map your objects to the input of this message processor, keep in mind that they need to match the expected types of the objects in Salesforce Marketing Cloud.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
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. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Action |
String |
The type of action to perform. |
x |
|
Object Type |
String |
The type of object being performed the action on. |
x |
|
Amount |
Number |
Specifies the amount of time, in the unit defined in Read timeout time unit, that the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read timeout. |
||
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. |
Create entities
<sfdc-marketing-cloud:create>
Creates one or more API objects. IMPORTANT: When you map your objects to the input of this message processor, keep in mind that they need to match the expected types of the objects in 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. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Amount |
Number |
Specifies the amount of time, in the unit defined in Read timeout time unit, that the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read timeout. |
||
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. |
Delete objects
<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. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Amount |
Number |
Specifies the amount of time, in the unit defined in Read timeout time unit, that the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read timeout. |
||
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. |
Perform action
<sfdc-marketing-cloud:perform>
Performs an action on a determined type of object. IMPORTANT: When you map your objects to the input of this message processor, keep in mind that they need to match the expected types of the objects in Salesforce Marketing Cloud..
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Definitions |
Array of Object |
An array of one or more definitions for the perform operation. |
Service URL[payload] |
|
Perform Options |
Object |
Options that can be made on the perform operation. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Action |
String |
The type of action to perform. |
x |
|
Object Type |
String |
The type of object being performed the action on. |
x |
|
Amount |
Number |
Specifies the amount of time, in the unit defined in Read timeout time unit, that the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read timeout. |
||
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. |
Retrieve entities
<sfdc-marketing-cloud:retrieve>
The Retrieve method enables the retrieval of a single object type. This method retrieves specified object properties only. You can apply filters to Retrieve methods 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. |
x |
|
RetrieveOptions |
Object |
Options that can be made on the update operation. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior. |
||
Amount |
Number |
Specifies the amount of time, in the unit defined in Read timeout time unit, that the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read timeout. |
||
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. |
Schedule start action
<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, keep in mind that they need to match the expected types of the objects in 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 on which to do a schedule. |
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. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Amount |
Number |
Specifies the amount of time, in the unit defined in Read timeout time unit, that the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read timeout. |
||
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. |
Unauthorize
<sfdc-marketing-cloud:unauthorize>
Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without repeating the authorization dance.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
Update entities
<sfdc-marketing-cloud:update>
Updates one or more API objects. IMPORTANT: When you map your objects to the input of this message processor, keep in mind that they need to match the expected types of the objects in 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. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Amount |
Number |
Specifies the amount of time, in the unit defined in Read timeout time unit, that the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read timeout. |
||
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. |
Upsert entities
<sfdc-marketing-cloud:upsert>
Upserts one or more API objects. IMPORTANT: When you map your objects to the input of this message processor, keep in mind that they need to match the expected types of the objects in 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. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
x |
|
Amount |
Number |
Specifies the amount of time, in the unit defined in Read timeout time unit, that the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read timeout. |
||
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. |
On modified object
<sfdc-marketing-cloud:modified-object-listener>
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-dd HH:mm:ss format (for example, 2017-03-17 16:30:40) to retrieve the selected objects. |
||
Amount |
Number |
Specifies the amount of time, in the unit defined in Read timeout time unit, that the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read timeout. |
||
Object type |
String |
x |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
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. |
On new object
<sfdc-marketing-cloud:new-object-listener>
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-dd HH:mm:ss format (that is, 2017-03-17 16:30:40) to retrieve the selected objects. |
||
Amount |
Number |
Specifies the amount of time, in the unit defined in Read timeout time unit, that the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read timeout. |
||
Object type |
String |
x |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
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. |
Types
Proxy Configuration
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Host |
String |
Host where the proxy requests is sent. |
x |
|
Port |
Number |
Port where the proxy requests is sent. |
x |
|
Username |
String |
The username to authenticate against the proxy. |
||
Password |
String |
The password to authenticate against the proxy. |
||
Non Proxy Hosts |
Array of String |
A list of hosts against which the proxy should not be used. |
||
Ntlm Domain |
String |
The domain to authenticate against the proxy. |
Tls
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server cannot be reached or is busy. |
Custom Ocsp Responder
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
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. |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
true |
Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect. |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
true |
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:
|
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. |
||
Message Digest Algorithm |
String |
The secure hashing algorithm to use. If not set, the default is SHA-256. |
||
Message Identifier |
Defines which strategy is used to identify the messages. |
|||
Object Store |
ObjectStore |
The object store where the redelivery counter for each message is stored. |
Redelivery Policy Message Identifier
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Use Secure Hash |
Boolean |
Whether to use a secure hash algorithm to identify a redelivered message. |
||
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. |
Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of instances that are initially be 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 the buffer 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 |
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 than or equal to zero means no limit. |
Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects |
Number |
The maximum amount of instances to keep in memory. If more than that is required, then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed. |