Skip to main content
(Use this example if your integration involves pulling dynamic content into MoEngage campaigns OR sending MoEngage data out to personalize experiences on your platform.)

[Partner Name] & MoEngage Integration

Author : [Your Company Name]
Date of Last Update : [Date]
(Provide a brief, 2-3 sentence introduction to your company and what you do. Then, explain the core value proposition of the integration with MoEngage. What key problem does it solve for our mutual customers?) For example: Partner Name : [Partner Name] Partner Category : Personalization

Overview 🚀

(Explain the core value of the integration. Describe how it enables marketers to create personalized user experiences, whether by pulling dynamic content into MoEngage campaigns or by using MoEngage data to tailor experiences on an external site/app.) The MoEngage and [Partner Name] integration enables you to deliver dynamic, 1-to-1 personalized content to your users within MoEngage campaigns. By fetching real-time content from [Partner Name], such as product recommendations, personalized images, or dynamic offers, you can significantly increase engagement and conversion. Additionally, this integration can send MoEngage user and event data to [Partner Name] , allowing you to personalize experiences on your website, app, or other channels based on a user’s cross-channel behavior.

Use Cases 🎯

(List the 2-3 primary things users can achieve with this integration. Be specific and action-oriented.)
  • Display Personalized Product Recommendations : Fetch and display product carousels in emails based on a user’s browsing history or purchase data.
  • Embed Dynamic, Personalized Images : Insert images into campaigns with the user’s name, loyalty points, or other attributes rendered in real-time.
  • Show Countdown Timers : Create urgency in flash sale campaigns by embedding a live countdown timer that renders uniquely for each user upon open.

Prerequisites ✅

(List everything a user must have before starting. Include account details, plan levels, and specific credentials needed from your platform, such as API Keys, Account IDs, or authentication tokens.)
  • An active MoEngage account.
  • An active [Partner Name] account on the [for example,Pro ,Enterprise ] plan.
  • Admin access to both platforms.
  • Your authentication credentials from the [Partner Name] dashboard (e.g., API Key, Account ID, Authentication Token).

Integration Setup 🛠️

(This is the most critical section. Clearly detail the setup steps for one or both integration types below, depending on what your platform supports. Use screenshots and provide specific examples of API endpoints, request bodies, and Jinja code where applicable.)

Part 1: Fetching [Partner Name] Content into MoEngage Campaigns

(Use this section if your integration provides content to be used inside MoEngage messages.)

Method A: Using MoEngage Content APIs

(Use this method for structured API responses, like JSON data for product recommendations.)

Step 1: Get Your API Credentials from [Partner Name]

  1. (Provide clear steps on where the user can find their API endpoint URL, API keys, and any other necessary credentials from your dashboard. Use screenshots.)
  2. API URL : https://api.your-platform.com/recommendations
  3. Authentication : Authorization: Bearer <YOUR_API_KEY>

Step 2: Set up a Content API in MoEngage

  1. On the left navigation menu in the MoEngage UI, go to Settings > Content API and click + Add content API.
  2. Enter your API endpoint URL from Step 1. You can use MoEngage’s personalization syntax to make the URL dynamic: https://api.partner.com/content?user_id={{UserAttribute['ID']}}
  3. Under Headers , add your authentication keys.
  4. Save and test the API. A successful test should show a sample of the data you expect to receive.

Method B: Using Dynamic Image URLs

(Use this method for embedding personalized images, timers, or other simple visual elements.)

Step 1: Create a Dynamic Element in [Partner Name]

  1. (Provide steps and screenshots showing how a user creates a personalized image or timer in your platform.)
  2. After creating the element, locate and copy the generated “Magic Link” or dynamic image URL. The URL will contain placeholder merge tags. Example URL: https://img.your-platform.com/v1/getImage?name=MERGE_TAG&points=POINTS_TAG

Step 2: Embed the URL in a MoEngage Campaign

(Provide screenshots showing your embeded content in MoEngage campaign editors and previews.)
  1. In the MoEngage campaign editor (e.g., for email), add an image or HTML block.
  2. Paste the dynamic URL from Step 1 as the image source.
  3. Replace the placeholder merge tags (e.g., MERGE_TAG) in the URL with MoEngage’s personalization syntax by typing @ or using {{...}}. Example with MoEngage syntax: https://img.your-platform.com/v1/getImage?name={{UserAttribute['First Name']}}&points={{UserAttribute['Loyalty Points']}}

Part 2: Sending MoEngage Data to [Partner Name]

(Use this section if your integration consumes MoEngage data to personalize experiences on your platform.)

Step 1: Get Your Data Destination Credentials from [Partner Name]

  1. (Explain how the user can get the necessary credentials for data delivery. For S3, this would include the S3 bucket URL, Access Key, and Secret Key. For a webhook, it would be the endpoint URL and any required auth tokens.)

Step 2: Configure a Data Export in MoEngage

  1. In the MoEngage UI, navigate to Settings > Exports.
  2. Choose the export type (e.g., S3 Export or Connector for webhooks).
  3. Configure the export by selecting the user events (e.g., Campaign Clicked, Product Viewed) and user attributes you want to send.
  4. Enter the destination credentials from Step 1 and save the configuration. Set a frequency for the export.

Troubleshooting & FAQs❓

(List 2-3 common issues users might face and their solutions). For example:

Issues

Example Issue: Personalized content is not appearing in the test email.
  • Verify API Request: Use the “Test” feature in the Content API settings to ensure MoEngage is receiving a valid 200 OK response from your server. Check the response body to make sure the expected data is present.
  • Check Jinja Syntax: Ensure the Jinja code used to parse the API response is correct. A common mistake is referencing a non-existent key in the JSON response.
  • Confirm User Data: Make sure the test user profile you are sending to has a value for the attribute used in the API call (e.g., if the URL uses {{UserAttribute['ID']}}Ensure the test user has a User ID).

FAQs

Content APIs are called in real-time for each user when the message is generated.
[Specify behavior] For example: If the API call fails or times out, the content will not be rendered. You can set a fallback in your Jinja code to display a default image or text.
For issues related to API availability or the data returned from your platform, contact your support team at [Partner Support Email/Link]. For issues related to campaign setup or Jinja templating within MoEngage, contact your Customer Success Manager.

Support 🤝

  • For issues related to [Partner Name] , contact our support team at [Partner Support Email or Link to Support Portal].
  • For issues related to the MoEngage platform, contact the MoEngage Support team.