Skip to main content

Introduction

This guide provides detailed instructions for setting up MoEngage Custom Activities in Salesforce Marketing Cloud (SFMC). Follow these steps to ensure a smooth integration and usage.
Prerequisites
  • Salesforce Marketing Cloud Access: Administrator and Marketing Cloud Administrator permissions are required.
  • MoEngage API Credentials: Ensure you have access to your MoEngage APIs (Settings > Accounts > APIs).

Step 1: Set up MoEngage custom activity

To set up the MoEngage custom activity, perform the following steps:
  1. Log in to your Salesforce Marketing Cloud (SFMC). Salesforce Marketing Cloud login screen
  2. Access SFMC settings. Accessing SFMC settings from the dashboard
  3. Once you click on “Installed Packages”, this tab will be visible on the right side of the page. Installed Packages tab in SFMC settings
  4. Create a new package. Creating a new package in SFMC Installed Packages
  5. Add package details. You can name it “MoEngage Custom Activity” and add description as “Used to send one-time push notifications and run Event Trigger campaigns”. Entering name and description for the MoEngage Custom Activity package
  6. Add MoEngage Components. Adding MoEngage Components to the package
  7. Click Add Component. Add Component button in SFMC package configuration
  8. Select “Journey Builder Activity” and click on “Next”. Selecting Journey Builder Activity as the component type
  9. Click Save.
  10. Repeat the same steps for MoEngage Event Destination. Adding MoEngage Event Destination component

Step 2: Set up the Cloud Page and the Data Extension

You need to set up a cloud page along with a data extension to capture the MoEngage workspace details. These can then be used while configuring a MoEngage destination in Journey Builder:
  1. Navigate to the SFMC Home page.
  2. Click “Platform” > “Package Manager”. Navigating to Platform > Package Manager in SFMC Once you click on the “Package Manager”, it will be redirected to the Package Manager page.
  3. Click on the “Deployment” tab.
  4. Click “Deploy”. Deployment tab and Deploy button in Package Manager
  5. Upload the MoEngage solution package JSON file. Uploading the MoEngage solution package JSON [Optional] If applicable, select a “CloudPages Domain” and click “Next”. Selecting an optional CloudPages Domain during deployment
  6. The system will validate the setup and check for any issues. Once validated, click Deploy. Validating and clicking Deploy in Package Manager

Publish Data Extensions and CloudPages

  1. Go to the “Homepage”.
  2. Click on “Web Studio”, and then click on “CloudPages”. Navigating to Web Studio > CloudPages
  3. Once you click “CloudPages”, it will be directed to this page. Click on “CloudPages”, then on “MoEngage Data Tracking” subfolder, and finally on “MoEngage Campaign Tracking CloudPage”.
  4. Click on the “arrow” to open the dropdown list and then click on “Edit”. Editing the MoEngage Campaign Tracking CloudPage
  5. Click on “Save” and then on “Schedule/Publish”. Saving and publishing the MoEngage Campaign Tracking CloudPage
  6. Return to the “CloudPages” page, click on “MoEngage Credentials” subfolder and then on “User Authentication Page”.
  7. Click on the “arrow” to open the dropdown list and then click on “Edit”. Editing the User Authentication Page CloudPage
  8. Click on “Save” and then on “Schedule/Publish”. Saving and publishing the User Authentication Page

Verify Data Extension and external keys

Ensure the following Data Extensions (DEs) are properly named and configured:

A. MoEngage Tracking Data

It stores campaign tracking information.
  1. Go to the “Homepage”.
  2. Click on “Audience Builder”, and then click on “Contact Builder”. Navigating to Audience Builder > Contact Builder
  3. Select “Data Extensions” tab.
  4. Click on “Data Extensions” folder, and then click on “MoEngage Data Track” subfolder.
  5. Select “MoEngage Tracking data” extension. MoEngage Tracking data Data Extension details Here you can find the “External Key”. Please ensure it is accurate. [Optional] If external key needs to be entered or changed, click on “External Key” input field, paste or enter the external key and click on “Done”.

B. MoEngage Credentials

It stores the credentials for the Data Tracking CloudPage:
  1. Go to the “Homepage”.
  2. Click on “Audience Builder”, and then click on “Contact Builder”. Navigating to Audience Builder > Contact Builder
  3. Select “Data Extensions” tab.
  4. Click on “Data Extensions” folder, and then click on “MoEngage Data Track” subfolder.
  5. Select “MoEngage Tracking Credential”. MoEngage Tracking Credential Data Extension details Here you can find the “External Key”. Please ensure it is accurate. [Optional] If external key needs to be entered or changed, click on “External Key” input field, paste or enter the external key and click on “Done”.

C. MoEngage Event Activity Log

It logs Event Custom Activity information.
  1. Go to the “Homepage”.
  2. Click on “Audience Builder”, and then click on “Contact Builder”. Navigating to Audience Builder > Contact Builder
  3. Select “Data Extensions” tab.
  4. Click on “Data Extensions” folder, and then click on “MoEngage Event DE” subfolder.
  5. Select “MoEngage Tracking Credential”. MoEngage Event DE folder with Data Extensions
  6. Select “MoEngage Event Activity Log”. Here you can find the “External Key”. Please ensure it is accurate. [Optional] If external key needs to be entered or changed, click on “External Key” input field, paste or enter the external key and click on “Done”. MoEngage Event Activity Log External Key field

D. MoEngage Push Activity Log

It logs Push Custom Activity information.
  1. Go to the “Homepage”.
  2. Click on “Audience Builder”, and then click on “Contact Builder”. Navigating to Audience Builder > Contact Builder
  3. Select “Data Extensions” tab.
  4. Click on “Data Extensions” folder, and then click on “MoEngage Push DE” subfolder.
  5. Select “MoEngage Push Activity Log”. MoEngage Push DE folder with Data Extensions Here you can find the “External Key”. Please ensure it is accurate. [Optional] If external key needs to be entered or changed, click on “External Key” input field, paste or enter the external key and click on “Done”. MoEngage Push Activity Log External Key field

Configure Data Extension

A. Configure Data Extensions

  1. Change the external key of the credentials data extension from the solution package to “MoEngage Credentials”. Changing external key of the Credentials Data Extension
  2. Change the external key of the “Sync Users to MoEngage” data extension from the solution package to “Sync Users to MoEngage”. Changing external key of the Sync Users to MoEngage Data Extension
  3. Change the external key of the “User Sync Automation Logs” data extension from the solution package to “User Sync Automation Logs”. Changing external key of the User Sync Automation Logs Data Extension

Connect your MoEngage workspace

A. Access the credentials cloud page

On your SFMC dashboard, perform the following steps:
  1. Navigate to “Web Studio” > “CloudPages” > “MoEngage Credentials” subfolder. Finally click on “MoEngage Authentication Page”. Click Edit.
  2. Click on the “Page URL” to open the Authentication Page. Opening the MoEngage Authentication Page URL
  3. Enter details of your MoEngage workspace and click Submit.
FieldValue
Data centerSelect your MoEngage data center. Refer to Data Centers in MoEngage for details.
Workspace NameEnter your workspace name. It is present in the header on your MoEngage dashboard. See the screenshot below.
Workspace IDNavigate to Settings > Accounts > APIs.
Data API keyNavigate to Settings > Accounts > APIs.
Campaign (Push) API KeyNavigate to Settings > Accounts > APIs.
Workspace name displayed in the MoEngage dashboard header Locating Workspace ID, Data API key, and Campaign API key in MoEngage Settings [Optional] After done, you can also validate if the newly added workspace is present in the Data Extension.