Salesforce Marketing Cloud

Salesforce Marketing Cloud is a digital marketing platform that automates email marketing, social media, apps, websites, and more.

Salesforce Marketing Cloud integration replicates data using the Salesforce Marketing Cloud both REST API and SOAP API.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

Before you create connections in Qlik Talend Cloud, make sure you have the following:

A Salesforce Professional, Corporate, or Enterprise license (required to use the Salesforce Marketing Cloud API).
A Salesforce Marketing Cloud Administrator user, or a System Administrator user in Salesforce.
An External Client App created in Salesforce. To integrate with Salesforce, external applications must use an External Client App (not a package).

The following instructions are available only in the Salesforce Lightning Experience menu. If you are using Salesforce Classic, switch to Salesforce Lightning Experience.

To retrieve your client ID and client secret:

Switch to Salesforce Lightning Experience if you are using Salesforce Classic.
Log into your Salesforce Marketing Cloud account.
In Setup, navigate to Apps > App Manager, and then click New External Client App.
Configure the app:
- Enter a name.
- Set Distribution State to Local.
- Under API (Enable OAuth Settings), select Enable OAuth and set OAuth Scopes to Full access.
- Under Flow Enablement, select Enable Client Credentials Flow.
Click Create.
Once the external app is created, navigate to Settings > OAuth Settings > Consumer Key and Secret.
When prompted, verify your identity using one of your registered methods.
Copy and paste your client ID and client secret into a secured file.
Navigate to Policies > Edit > OAuth Policies, and then enable Enable Client Credentials Flow.
In Run As (Username), enter your email, and then click Save.

To enable REST API access:

Log into your Salesforce Marketing Cloud account.
In Setup, navigate to Apps > External Client Apps > Settings.
Enable Allow access to External Client App consumer secrets via REST API.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
Client ID	Client ID.
Client Secret	Client secret.
Tenant Subdomain	The tenant subdomain for your Salesforce Marketing Cloud account. Example: https://subdomain.auth.marketingcloudapis.com, enter subdomain.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and information displayed below is for version 1.

Depending on your destination, table and column names may not appear as they are outlined below.

campaigns

The campaigns table contains information about the campaigns in your Salesforce Marketing Cloud account.

Replication Method	Full Table
Primary Key	id
Replication Key	modifiedDate
Useful links	Salesforce Marketing Cloud API method

campaignCode

STRING

color

STRING

createdDate

STRING

description

STRING

modifiedDate

STRING

name

STRING

content_areas

The content_areas table contains information about the reusable content sections in your Salesforce Marketing Cloud account.

Replication Method	CDC
Primary Key	ID
Replication Key	ModifiedDate
Useful links	Salesforce Marketing Cloud API method

Join content_areas with	on
emails	content_areas.ID = emails.ContentAreaIDs content_areas.CategoryID = emails.CategoryID
folders	content_areas.CategoryID = folders.ID content_areas.CategoryID = folders.ParentFolder
lists	content_areas.CategoryID = lists.Category

Join content_areas with

emails

content_areas.ID = emails.ContentAreaIDs

content_areas.CategoryID = emails.CategoryID

folders

content_areas.CategoryID = folders.ID

content_areas.CategoryID = folders.ParentFolder

lists

content_areas.CategoryID = lists.Category

BackgroundColor

STRING

BorderColor

STRING

BorderWidth

INTEGER

CategoryID

INTEGER

Cellpadding

INTEGER

Cellspacing

INTEGER

Content

STRING

CreatedDate

STRING

CustomerKey

STRING

FontFamily

STRING

HasFontSize

BOOLEAN

INTEGER

IsBlank

BOOLEAN

IsDynamicContent

BOOLEAN

IsLocked

BOOLEAN

IsSurvey

BOOLEAN

Key

STRING

ModifiedDate

STRING

Name

STRING

ObjectID

STRING

PartnerProperties

ARRAY

This is a nested data structure:

Name: STRING
Value: STRING

Width

INTEGER

data_extension

The data_extension table contains information about the data extensions in your Salesforce Marketing Cloud account. A table will be created for each data extension in your Salesforce Marketing Cloud account.

For example: If there are two data extensions named MobileAddress and MobileSubscription, two tables would be created: data_extension._MobileAddress and data_extension._MobileSubscription

Note: Retrieving data extension data requires Read, Write permissions for Data Extensions.

Replication Method	Full Table
Primary Key	_CustomObjectKey
Useful links	Salesforce Marketing Cloud API method

CategoryID

INTEGER

_CustomObjectKey

STRING

emails

The emails table contains information about the emails in your Salesforce Marketing Cloud account.

Replication Method	CDC
Primary Key	ID
Replication Key	ModifiedDate
Useful links	Salesforce Marketing Cloud API method

Join emails with	on
content_areas	emails.ContentAreaIDs = content_areas.ID emails.CategoryID = content_areas.CategoryID
sends	emails.ID = sends.EmailID emails.ClonedFromID = sends.EmailID
folders	emails.CategoryID = folders.ID emails.CategoryID = folders.ParentFolder
lists	emails.CategoryID = lists.Category

CategoryID

INTEGER

CharacterSet

STRING

ClonedFromID

INTEGER

ContentAreaIDs

ARRAY

This is a nested data structure.

ContentCheckStatus

STRING

CreatedDate

STRING

CustomerKey

STRING

EmailType

STRING

HTMLBody

STRING

HasDynamicSubjectLine

BOOLEAN

INTEGER

IsActive

BOOLEAN

IsHTMLPaste

BOOLEAN

ModifiedDate

STRING

Name

STRING

ObjectID

STRING

PartnerProperties

ARRAY

This is a nested data structure:

Name: STRING
Value: STRING

PreHeader

STRING

Status

STRING

Subject

STRING

SyncTextWithHTML

BOOLEAN

TextBody

STRING

__AdditionalEmailAttribute1

STRING

__AdditionalEmailAttribute2

STRING

__AdditionalEmailAttribute3

STRING

__AdditionalEmailAttribute4

STRING

__AdditionalEmailAttribute5

STRING

events

The events table contains information about the events in your Salesforce Marketing Cloud account.

When events are replicated to the destination, they are split into the following tables: BounceEvent, ClickEvent, OpenEvent, SentEvent, and UnsubEvent.

Replication Method	CDC
Primary Keys	EventType EventDate SendID SubscriberKey
Replication Key	EventDate
Useful links

Join events with	on
list_sends	events.SendID = list_sends.SendID
sends	events.SendID = sends.ID
list_subscribers	events.SubscriberKey = list_subscribers.SubscriberKey
subscribers	events.SubscriberKey = subscribers.ID

BatchID

INTEGER

CorrelationID

STRING

EventDate

DATE-TIME

EventType

STRING

SendID

INTEGER

SubscriberKey

STRING

URL

STRING

folders

The folders table contains information about the folders in your Salesforce Marketing Cloud account.

Replication Method	CDC
Primary Key	ID
Replication Key	ModifiedDate
Useful links	Salesforce Marketing Cloud API method

Join folders with	on
content_areas	folders.ID = content_areas.CategoryID folders.ParentFolder = content_areas.CategoryID
emails	folders.ID = emails.CategoryID folders.ParentFolder = emails.CategoryID
lists	folders.ID = lists.Category folders.ParentFolder = lists.Category

Join folders with

content_areas

folders.ID = content_areas.CategoryID

folders.ParentFolder = content_areas.CategoryID

emails

folders.ID = emails.CategoryID

folders.ParentFolder = emails.CategoryID

lists

folders.ID = lists.Category

folders.ParentFolder = lists.Category

AllowChildren

BOOLEAN

ContentType

STRING

CreatedDate

STRING

CustomerKey

STRING

Description

STRING

INTEGER

ModifiedDate

STRING

Name

STRING

ObjectID

STRING

ParentFolder

INTEGER

PartnerProperties

ARRAY

This is a nested data structure:

Name: STRING
Value: STRING

Type

STRING

list_sends

The list_sends table contains information about the completed sends for lists in your Salesforce Marketing Cloud account.

Replication Method	CDC
Primary Keys	ListID SendID
Replication Key	ModifiedDate
Useful links	Salesforce Marketing Cloud API method

Join list_sends with	on
lists	list_sends.ListID = lists.ID
list_subscribers	list_sends.ListID = list_subscribers.ListID
subscribers	list_sends.ListID = subscribers.ListIDs
events	list_sends.SendID = events.SendID
sends	list_sends.SendID = sends.ID

CreatedDate

STRING

CustomerKey

STRING

ExistingUndeliverables

INTEGER

ExistingUnsubscribes

INTEGER

ForwardedEmails

INTEGER

HardBounces

INTEGER

InvalidAddresses

INTEGER

ListID

INTEGER

MissingAddresses

INTEGER

ModifiedDate

STRING

NumberDelivered

INTEGER

NumberSent

INTEGER

ObjectID

STRING

OtherBounces

INTEGER

PartnerProperties

ARRAY

This is a nested data structure:

Name: STRING
Value: STRING

SendID

INTEGER

SoftBounces

INTEGER

UniqueClicks

INTEGER

UniqueOpens

INTEGER

Unsubscribes

INTEGER

list_subscribers

The list_subscribers table contains information about the lists associated with a specific subscriber in your Salesforce Marketing Cloud account.

Replication Method	CDC
Primary Keys	ListID SubscriberKey
Replication Key	ModifiedDate
Useful links	Salesforce Marketing Cloud API method

Join list_subscribers with	on
lists	list_subscribers.ListID = lists.ID
list_sends	list_subscribers.ListID = list_sends.ListID
subscribers	list_subscribers.ListID = subscribers.ListIDs list_subscribers.SubscriberKey = subscribers.ID
events	list_subscribers.SubscriberKey = events.SubscriberKey

CreatedDate

STRING

INTEGER

ListID

INTEGER

ModifiedDate

STRING

ObjectID

STRING

PartnerProperties

ARRAY

This is a nested data structure:

Name: STRING
Value: STRING

Status

STRING

SubscriberKey

STRING

lists

The lists table contains information about the lists in your Salesforce Marketing Cloud account.

Replication Method	CDC
Primary Key	ID
Replication Key	ModifiedDate
Useful links	Salesforce Marketing Cloud documentation Salesforce Marketing Cloud API method

Join lists with	on
content_areas	lists.Category = content_areas.CategoryID
emails	lists.Category = emails.CategoryID
folders	lists.Category = folders.ID lists.Category = folders.ParentFolder
list_sends	lists.ID = list_sends.ListID
list_subscribers	lists.ID = list_subscribers.ListID
subscribers	lists.ID = subscribers.ListIDs

Category

INTEGER

CreatedDate

STRING

Description

STRING

INTEGER

ListClassification

STRING

ListName

STRING

ModifiedDate

STRING

ObjectID

STRING

PartnerProperties

ARRAY

This is a nested data structure:

Name: STRING
Value: STRING

SendClassification

STRING

Type

STRING

sends

The sends table contains information about the email sends in your Salesforce Marketing Cloud account.

Replication Method	CDC
Primary Key	ID
Replication Key	ModifiedDate
Useful links	Salesforce Marketing Cloud API method

Join sends with	on
emails	sends.EmailID = emails.ID sends.EmailID = emails.ClonedFromID
events	sends.ID = events.SendID
list_sends	sends.ID = list_sends.SendID

Join sends with

emails

sends.EmailID = emails.ID

sends.EmailID = emails.ClonedFromID

events

sends.ID = events.SendID

list_sends

sends.ID = list_sends.SendID

CreatedDate

STRING

EmailID

INTEGER

EmailName

STRING

FromAddress

STRING

FromName

STRING

INTEGER

IsAlwaysOn

BOOLEAN

IsMultipart

BOOLEAN

ModifiedDate

STRING

PartnerProperties

ARRAY

This is a nested data structure:

Name: STRING
Value: STRING

SendDate

DATE-TIME

SentDate

DATE-TIME

Status

STRING

Subject

STRING

subscribers

The subscribers table contains information about the subscribers (people subscribed to receive email and/or SMS communication) in your Salesforce Marketing Cloud account.

Replication Method	CDC
Primary Key	ID
Replication Key	ModifiedDate
Useful links	Salesforce Marketing Cloud API method

Join subscribers with	on
lists	subscribers.ListIDs = lists.ID
list_sends	subscribers.ListIDs = list_sends.ListID
list_subscribers	subscribers.ListIDs = list_subscribers.ListID subscribers.ID = list_subscribers.SubscriberKey
events	subscribers.ID = events.SubscriberKey

Addresses

ARRAY

This is a nested data structure:

Address: STRING
AddressStatus: STRING
AddressType: STRING

Attributes

ARRAY

This is a nested data structure:

Name: STRING
Value: STRING

CreatedDate

STRING

CustomerKey

STRING

EmailAddress

STRING

EmailTypePreference

STRING

INTEGER

ListIDs

ARRAY

This is a nested data structure.

Locale

STRING

ModifiedDate

STRING

ObjectID

STRING

PartnerKey

STRING

PartnerProperties

ARRAY

This is a nested data structure:

Name: STRING
Value: STRING

PartnerType

STRING

PrimaryEmailAddress

STRING

PrimarySMSAddress

STRING

PrimarySMSPublicationStatus

STRING

Status

STRING

SubscriberKey

STRING

SubscriberTypeDefinition

STRING

UnsubscribedDate

STRING

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here