Add salesforce marketing cloud connector documentation #1451
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aashikam
requested review from
arunans23,
chanikag,
DinithiDiaz and
anupama-pathirage
as code owners
12 tasks
DinithiDiaz
reviewed
Mar 11, 2025
.../connectors/salesforce-marketing-cloud-connector/salesforce-marketing-cloud-configuration.md
Outdated
Show resolved
Hide resolved
DinithiDiaz
reviewed
Mar 11, 2025
.../connectors/salesforce-marketing-cloud-connector/salesforce-marketing-cloud-configuration.md
Outdated
Show resolved
Hide resolved
DinithiDiaz
reviewed
Mar 11, 2025
...rence/connectors/salesforce-marketing-cloud-connector/salesforce-marketing-cloud-overview.md
Outdated
Show resolved
Hide resolved
chanikag
reviewed
Mar 11, 2025
.../connectors/salesforce-marketing-cloud-connector/salesforce-marketing-cloud-configuration.md
Outdated
Show resolved
Hide resolved
chanikag
reviewed
Mar 11, 2025
...cs/reference/connectors/salesforce-marketing-cloud-connector/sfmc-access-token-generation.md
Outdated
Show resolved
Hide resolved
chanikag
reviewed
Mar 11, 2025
aashikam
force-pushed
the
sfmc
branch
2 times, most recently
from
1fe31d8 to
af9ea3e
Compare
chanikag
reviewed
Mar 25, 2025
|
|
||
| <img src="{{base_path}}/assets/img/integrate/connectors/sfmc/sfmc-client.png" title="SFMC client id" width="95%" alt="SFMC client id"/> | ||
|
|
||
| ### Step 5: Retrieve Your User Subdomain (Required for setting up MI) |
There was a problem hiding this comment.
Suggested change
| ### Step 5: Retrieve Your User Subdomain (Required for setting up MI) | |
| ### Step 5: Retrieve your user subdomain (Required for setting up MI) |
chanikag
reviewed
Mar 25, 2025
|
|
||
| <img src="{{base_path}}/assets/img/integrate/connectors/sfmc/sfmc-new-component.png" title="SFMC new component" width="75%" alt="SFMC installed package component"/> | ||
|
|
||
| ### Step 3: Add an API Integration Component |
There was a problem hiding this comment.
Suggested change
| ### Step 3: Add an API Integration Component | |
| ### Step 3: Add an API integration component |
chanikag
reviewed
Mar 25, 2025
|
|
||
| <img src="{{base_path}}/assets/img/integrate/connectors/sfmc/sfmc-setup.png" title="SFMC setup" width="50%" alt="SFMC setup"/> | ||
|
|
||
| ### Step 2: Create an Installed Package |
There was a problem hiding this comment.
Suggested change
| ### Step 2: Create an Installed Package | |
| ### Step 2: Create an installed package |
DinithiDiaz
reviewed
Mar 27, 2025
| 2. DomainKeys Identified Mail (DKIM): DKIM adds a cryptographic signature to outgoing emails, verifying they weren't altered in transit. Generate and activate DKIM keys in Salesforce and add the provided CNAME records to your DNS. [Learn more about DKIM setup](https://help.salesforce.com/s/articleView?id=sf.emailadmin_setup_dkim_key.htm&type=5). | ||
| 3. Domain-based Message Authentication, Reporting, and Conformance (DMARC): DMARC builds on SPF and DKIM to define how email receivers should handle authentication failures and provides reporting. [Learn more about DMARC](https://help.salesforce.com/s/articleView?id=sf.emailadmin_dmarc.htm&type=5). | ||
|
|
||
| ## Create and Send Emails in Salesforce Marketing Cloud |
There was a problem hiding this comment.
Suggested change
| ## Create and Send Emails in Salesforce Marketing Cloud | |
| ## Create and send emails in Salesforce Marketing Cloud |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| ## Create and Send Emails in Salesforce Marketing Cloud | ||
|
|
||
| ### Step 1: Log in and Access Email Studio |
There was a problem hiding this comment.
Suggested change
| ### Step 1: Log in and Access Email Studio | |
| ### Step 1: Log in and access Email Studio |
DinithiDiaz
reviewed
Mar 27, 2025
| @@ -0,0 +1,99 @@ | |||
| # Prerequisites for Sending an Email | |||
|
|
|||
| **Note**: Make sure authentication is set up before sending emails to prevent them from being bounced. Specifically, if the sending domain fails any of the SPF, DKIM, or DMARC checks, the email will be rejected. | |||
There was a problem hiding this comment.
Suggested change
| **Note**: Make sure authentication is set up before sending emails to prevent them from being bounced. Specifically, if the sending domain fails any of the SPF, DKIM, or DMARC checks, the email will be rejected. | |
| !!!Note | |
| Make sure authentication is set up before sending emails to prevent them from being bounced. Specifically, if the sending domain fails any of the SPF, DKIM, or DMARC checks, the email will be rejected. |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| <img src="{{base_path}}/assets/img/integrate/connectors/sfmc/email-template-home.png" title="Email Template Home" width="50%" alt="Email Template Home"/> | ||
|
|
||
| 2. Click “New Email Template,” fill in the required details, and save. |
There was a problem hiding this comment.
Suggested change
| 2. Click “New Email Template,” fill in the required details, and save. | |
| 2. Click **New Email Template**, fill in the required details, and save. |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| <img src="{{base_path}}/assets/img/integrate/connectors/sfmc/email-template-new.png" title="New Email Template" width="100%" alt="New Email Template"/> | ||
|
|
||
| 3. Open the template details page and click "Edit in Builder." From there, you can modify the HTML, paste an existing template, or choose from their available templates. I have also added a custom HTML template, which you can find [here](https://gist.github.com/aashikam/999fc472ebc16e06be4e72f644fff55d). |
There was a problem hiding this comment.
Suggested change
| 3. Open the template details page and click "Edit in Builder." From there, you can modify the HTML, paste an existing template, or choose from their available templates. I have also added a custom HTML template, which you can find [here](https://gist.github.com/aashikam/999fc472ebc16e06be4e72f644fff55d). | |
| 3. Open the template details page and click **Edit in Builder**. From there, you can modify the HTML, paste an existing template, or choose from their available templates. |
Remove this phrase. We can upload this file to the attachments folder in the doc space to be downloaded.
Download a custom HTML template [here](insert link).
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| ### Step 3: Create the Email Message in Content Builder | ||
|
|
||
| 1. From Email Studio, click on “Content.” |
There was a problem hiding this comment.
Suggested change
| 1. From Email Studio, click on “Content.” | |
| 1. From Email Studio, click on **Content**. |
DinithiDiaz
reviewed
Mar 27, 2025
| ### Step 3: Create the Email Message in Content Builder | ||
|
|
||
| 1. From Email Studio, click on “Content.” | ||
| 2. Choose “Create” and select your preferred email type (Template Based, HTML Paste, or Text Only). |
There was a problem hiding this comment.
Suggested change
| 2. Choose “Create” and select your preferred email type (Template Based, HTML Paste, or Text Only). | |
| 2. Choose **Create** and select your preferred email type (Template Based, HTML Paste, or Text Only). |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| ### Step 4 Configure a Sender Profile | ||
|
|
||
| 1. In Email Studio, click the “Admin” tab (or use the Email drop-down to find Admin). |
There was a problem hiding this comment.
Suggested change
| 1. In Email Studio, click the “Admin” tab (or use the Email drop-down to find Admin). | |
| 1. In Email Studio, click the **Admin** tab (or use the Email drop-down to find **Admin**). |
DinithiDiaz
reviewed
Mar 27, 2025
| ### Step 4 Configure a Sender Profile | ||
|
|
||
| 1. In Email Studio, click the “Admin” tab (or use the Email drop-down to find Admin). | ||
| 2. Find the “Sender Profiles” option in the left-hand menu. |
There was a problem hiding this comment.
Suggested change
| 2. Find the “Sender Profiles” option in the left-hand menu. | |
| 2. Find the **Sender Profiles** option in the left-hand menu. |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| <img src="{{base_path}}/assets/img/integrate/connectors/sfmc/sender-profiles.png" title="Sender Profiles" width="30%" alt="Sender Profiles"/> | ||
|
|
||
| 3. Click “Create” to make a new profile or select an existing profile to update. |
There was a problem hiding this comment.
Suggested change
| 3. Click “Create” to make a new profile or select an existing profile to update. | |
| 3. Click **Create** to make a new profile or select an existing profile to update. |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| <img src="{{base_path}}/assets/img/integrate/connectors/sfmc/new-profile.png" title="New Profile" width="100%" alt="New Profile"/> | ||
|
|
||
| 4. Provide a “From Name” and a verified “From Email Address” that is authorized in your Salesforce Marketing Cloud account. |
There was a problem hiding this comment.
Suggested change
| 4. Provide a “From Name” and a verified “From Email Address” that is authorized in your Salesforce Marketing Cloud account. | |
| 4. Provide a **From Name** and a verified **From Email Address** that is authorized in your Salesforce Marketing Cloud account. |
DinithiDiaz
reviewed
Mar 27, 2025
| Confirm that your response includes an access_token. | ||
| Save the token securely. It is valid for the duration specified in the response and will be required for subsequent API calls. | ||
|
|
||
| > Note: WSO2 MI will handle token generation and expiration internally. You only need to provide the Client ID and Client Secret in your API configuration. |
There was a problem hiding this comment.
Suggested change
| > Note: WSO2 MI will handle token generation and expiration internally. You only need to provide the Client ID and Client Secret in your API configuration. | |
| !!!Note | |
| WSO2 MI will handle token generation and expiration internally. You only need to provide the Client ID and Client Secret in your API configuration. |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| 5. Verify the Token: | ||
|
|
||
| Confirm that your response includes an access_token. |
There was a problem hiding this comment.
Suggested change
| Confirm that your response includes an access_token. | |
| Confirm that your response includes an `access_token`. |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| ### Step 2: Create an Installed Package | ||
|
|
||
| 1. In the Setup menu, scroll down to the Platform Tools section. |
There was a problem hiding this comment.
Suggested change
| 1. In the Setup menu, scroll down to the Platform Tools section. | |
| 1. In the **Setup** menu, scroll down to the **Platform Tools** section. |
DinithiDiaz
reviewed
Mar 27, 2025
| ### Step 2: Create an Installed Package | ||
|
|
||
| 1. In the Setup menu, scroll down to the Platform Tools section. | ||
| 2. Click on Apps and then select Installed Packages. |
There was a problem hiding this comment.
Suggested change
| 2. Click on Apps and then select Installed Packages. | |
| 2. Click on **Apps** and then select **Installed Packages**. |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| <img src="{{base_path}}/assets/img/integrate/connectors/sfmc/sfmc-packages.png" title="SFMC packages" width="50%" alt="SFMC installed packages"/> | ||
|
|
||
| 3. Click the New button. |
There was a problem hiding this comment.
Suggested change
| 3. Click the New button. | |
| 3. Click the **New** button. |
DinithiDiaz
reviewed
Mar 27, 2025
| <img src="{{base_path}}/assets/img/integrate/connectors/sfmc/sfmc-packages.png" title="SFMC packages" width="50%" alt="SFMC installed packages"/> | ||
|
|
||
| 3. Click the New button. | ||
| 4. Enter a Name and Description for your package (for example, “API Integration Package”). |
There was a problem hiding this comment.
Suggested change
| 4. Enter a Name and Description for your package (for example, “API Integration Package”). | |
| 4. Enter a **Name** and **Description** for your package (for example, `API Integration Package`). |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| 3. Click the New button. | ||
| 4. Enter a Name and Description for your package (for example, “API Integration Package”). | ||
| 5. Click Save. |
There was a problem hiding this comment.
Suggested change
| 5. Click Save. | |
| 5. Click **Save**. |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| <img src="{{base_path}}/assets/img/integrate/connectors/sfmc/sfmc-component-details.png" title="SFMC new component details" width="95%" alt="SFMC installed package component details"/> | ||
|
|
||
| 2. Click on Add Component. |
There was a problem hiding this comment.
Suggested change
| 2. Click on Add Component. | |
| 2. Click on **Add Component**. |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| <img src="{{base_path}}/assets/img/integrate/connectors/sfmc/sfmc-scope.png" title="SFMC component scope" width="75%" alt="SFMC component scopes"/> | ||
|
|
||
| 6. Click Save to add the component. |
There was a problem hiding this comment.
Suggested change
| 6. Click Save to add the component. | |
| 6. Click **Save** to add the component. |
DinithiDiaz
reviewed
Mar 27, 2025
|
|
||
| Extract the subdomain by taking the portion between `https://` and `.auth.marketingcloudapis.com` in your base URI. For example, from `https://mczl3z3cmqr47kmts5x34v1cdlky.auth.marketingcloudapis.com/`, the subdomain is `mczl3z3cmqr47kmts5x34v1cdlky`. | ||
|
|
||
| ### Step 6: Obtain the Access Token |
There was a problem hiding this comment.
Suggested change
| ### Step 6: Obtain the Access Token | |
| ### Step 6: Obtain the access token |
DinithiDiaz
reviewed
Mar 27, 2025
| https://YOUR_SUBDOMAIN.auth.marketingcloudapis.com/ | ||
| ``` | ||
|
|
||
| 2. Replace YOUR_SUBDOMAIN with the subdomain provided in your Salesforce Marketing Cloud account (found in your account details). |
There was a problem hiding this comment.
Suggested change
| 2. Replace YOUR_SUBDOMAIN with the subdomain provided in your Salesforce Marketing Cloud account (found in your account details). | |
| 2. Replace `YOUR_SUBDOMAIN` with the subdomain provided in your Salesforce Marketing Cloud account (found in your account details). |
DinithiDiaz
reviewed
Mar 27, 2025
| ``` | ||
|
|
||
| 2. Replace YOUR_SUBDOMAIN with the subdomain provided in your Salesforce Marketing Cloud account (found in your account details). | ||
| 3. Construct the Token Request: |
There was a problem hiding this comment.
Suggested change
| 3. Construct the Token Request: | |
| 3. Construct the token request: |
DinithiDiaz
reviewed
Mar 27, 2025
| ``` | ||
| The output will be a JSON object that contains your access token. | ||
|
|
||
| 5. Verify the Token: |
There was a problem hiding this comment.
Suggested change
| 5. Verify the Token: | |
| 5. Verify the token: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Add documentation for the salesforce marketing cloud connector.