> ## Documentation Index
> Fetch the complete documentation index at: https://moengage.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> A roadmap for partners to explore, build, test, document, and publish an integration on the MoEngage App Marketplace.

Welcome, Partner!

This guide is your roadmap to building, testing, and publishing an integration on the MoEngage App Marketplace. Follow the steps below from start to finish — or jump to the section that matches where you are in the process.

The journey has seven stages: **Explore → Sandbox → Build → Test → Submit → Document → Launch**.

## Step 1: Understand the MoEngage Ecosystem

Before you start building, take a few minutes to understand how the MoEngage partner ecosystem works and what tools are available to you.

### Essential Reading

<CardGroup cols={3}>
  <Card title="App Marketplace" icon="store" href="/docs/partner-guide/integrate-with-us/foundations/app-marketplace">
    Where your integration will be listed and discovered by customers.
  </Card>

  <Card title="Guidelines" icon="clipboard-list" href="/docs/partner-guide/integrate-with-us/foundations/guidelines">
    Best practices and requirements for building a robust integration.
  </Card>

  <Card title="Key Concepts" icon="book-open" href="/docs/partner-guide/integrate-with-us/foundations/key-concepts">
    Glossary of terms and concepts you'll encounter throughout.
  </Card>
</CardGroup>

### Explore What's Possible

MoEngage supports a wide range of integration patterns. Understanding the use cases below will help you choose the right approach for your platform.

<AccordionGroup>
  <Accordion title="Send Data to MoEngage — Sync user profiles, events, and segments into MoEngage">
    * [**Send User Data**](/docs/partner-guide/integrate-with-us/explore-capabilities/send-user-data): Sync user profiles and attributes from your platform to MoEngage.

    Ideal for CRMs, CDPs, e-commerce platforms, form tools, and any system that collects user data.
  </Accordion>

  <Accordion title="Receive Data from MoEngage — Stream data from MoEngage to your platform">
    * [**Receive Data**](/docs/partner-guide/integrate-with-us/explore-capabilities/receive-data): Stream user and event data from MoEngage to your platform in real-time.

    Ideal for analytics platforms, data warehouses, and BI tools that need MoEngage engagement data.
  </Accordion>

  <Accordion title="Trigger & Run Campaigns — Initiate campaigns from your app or use external content">
    * [**Trigger Campaigns**](/docs/partner-guide/integrate-with-us/explore-capabilities/trigger-campaigns): Initiate marketing campaigns in MoEngage based on actions in your application.
    * [**Use External Creatives**](/docs/partner-guide/integrate-with-us/explore-capabilities/use-external-creatives-in-campaigns): Allow marketers to use images, GIFs, and other creatives from your platform within MoEngage campaigns.

    Ideal for messaging platforms, ad networks, creative tools, and marketing automation systems.
  </Accordion>

  <Accordion title="Enrich & Personalize — Fetch real-time data or create dynamic content">
    * [**Dynamically Fetch Data**](/docs/partner-guide/integrate-with-us/explore-capabilities/dynamically-fetch-data): Enrich MoEngage campaigns with real-time data from your application.
    * [**Create Content Creatives**](/docs/partner-guide/integrate-with-us/explore-capabilities/create-content-creatives): Enable the creation of dynamic, personalized content for use in campaigns.

    Ideal for recommendation engines, content management systems, and personalization platforms.
  </Accordion>
</AccordionGroup>

For a complete overview of all supported patterns, see [Integration use-cases](/docs/partner-guide/integrate-with-us/explore-capabilities/integration-use-cases).

## Step 2: Get Your Sandbox

To start building, you'll need a MoEngage Sandbox Workspace. This is a dedicated environment where you can explore the platform, build your integration, and test it thoroughly before going live.

<Info>
  **Request Your Sandbox**

  Follow the [Account Setup guide](/docs/partner-guide/integrate-with-us/foundations/account-setup) to request access. You'll receive sandbox credentials within 1–2 business days.
</Info>

## Step 3: Choose Your Integration Path

MoEngage offers two primary pathways for building your integration. The right choice depends on your use case, technical requirements, and how much control you need.

<CardGroup cols={2}>
  <Card title="Connected Apps — Low-Code Framework (Recommended)" icon="zap">
    Define your integration logic in a simple config file. No heavy engineering required.

    Two sub-types:

    * **Connected Sources**: send data into MoEngage via webhooks.
    * **Connected Channels**: send data from MoEngage to your app.
  </Card>

  <Card title="MoEngage APIs — Custom Integration (Advanced)" icon="wrench">
    Full control over data flow with our REST APIs. Build any custom integration you need.

    Best for:

    * Complex or unique use cases
    * Granular control over logic
    * Teams with dedicated dev resources
  </Card>
</CardGroup>

### Detailed Comparison

| Criteria           | Connected Apps                                                                 | MoEngage APIs                                                |
| ------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------ |
| Use case           | Send users/events to MoEngage, or run campaigns & sync audiences from MoEngage | Highly complex or unique flows not covered by Connected Apps |
| Engineering effort | Low — config-driven, no custom backend                                         | High — custom code, API handling, error management           |
| Time to launch     | Days to weeks                                                                  | Weeks to months                                              |
| Flexibility        | Standardized framework with configuration options                              | Full granular control over every aspect                      |

<Tip>
  **Recommendation:** Start with **Connected Apps** for all supported use cases. It's faster, simpler, and covers the vast majority of integration patterns. Only choose the API route if your use case genuinely requires it.
</Tip>

### Connected Apps: Sources vs Channels

If you've chosen Connected Apps, the next question is: which direction does the data flow?

<CardGroup cols={2}>
  <Card title="Connected Sources" icon="arrow-up" href="/docs/partner-guide/integrate-with-us/build-integration/connected-sources">
    Your platform sends data **into** MoEngage. Build a webhook-based integration using a JSON mapper configuration.

    Common use cases:

    * Sync CRM contacts & profiles
    * Stream form submissions & lead captures
    * Track e-commerce events (orders, carts)
    * Send payment/subscription events
  </Card>

  <Card title="Connected Channels" icon="arrow-down" href="/docs/partner-guide/integrate-with-us/build-integration/connected-apps">
    MoEngage sends data **to** your platform. Build a channel connector using a JSON config file uploaded in-dashboard.

    Common use cases:

    * Send messages via your platform (SMS, chat)
    * Sync audiences to ad platforms
    * Push data to support/CRM tools
    * Trigger actions in external systems
  </Card>
</CardGroup>

## Step 4: Test Your Integration

A robust and reliable integration is key to a successful partnership. Thorough testing ensures a smooth experience for our mutual customers and builds trust in your solution. All testing should be conducted in your **MoEngage Sandbox Workspace**.

<Info>
  Read the complete guide: [Test Your Integration](/docs/partner-guide/integrate-with-us/build-integration/test-your-integration).
</Info>

## Step 5: Submit for Publishing

Once your integration is working correctly, submit it for review. The process depends on where the integration is configured:

<CardGroup cols={2}>
  <Card title="External Configuration" icon="globe">
    Setup happens on **your platform**. MoEngage lists your app on our marketplace with a link to your documentation for setup instructions.

    Example: Your platform has a "Connect to MoEngage" button and manages the auth flow.
  </Card>

  <Card title="Internal Configuration" icon="house">
    Setup happens **within MoEngage** (for example, Connected Apps). MoEngage publishes the configured app to our platform after review.

    See the submission details in the [Connected Apps](/docs/partner-guide/integrate-with-us/build-integration/connected-apps) guide.
  </Card>
</CardGroup>

<Warning>
  **Include with your submission:** End-to-end test instructions, access to your platform for verification, and confirmation that data flow and campaigns are working as expected.
</Warning>

## Step 6: Write Your Integration Guide

Help customers understand your integration, set it up, and troubleshoot issues. A clear, well-structured guide reduces support load and increases adoption.

Follow the [MoEngage Partner Integration Documentation Guide](/docs/partner-guide/integrate-with-us/documentation-guide/writing-guide/getting-started) to create a comprehensive help guide for your integration.

## Step 7: Get Listed & Promote

In addition to the in-app marketplace, MoEngage features partners on the public [MoEngage App Marketplace](https://www.moengage.com/app-marketplace). This is a co-marketing and lead-generation opportunity that showcases your solution to a broader audience.

### What you'll need for listing

<CardGroup cols={3}>
  <Card title="App Icon" icon="image">
    High-resolution logo for your application.
  </Card>

  <Card title="Description" icon="pencil">
    Comprehensive description of your app and use cases.
  </Card>

  <Card title="Setup Guide" icon="book">
    Public documentation link for setup instructions.
  </Card>
</CardGroup>

Read the full guide: [List as a Partner](/docs/partner-guide/integrate-with-us/publish-integration/list-as-a-partner).

Submit your listing: [Partner Listing Submission Form](https://forms.gle/bzPwoXQEx6bFGNyj6).

### Promote your integration

Once approved, you'll be listed as a MoEngage partner — unlocking revenue-driving partnership opportunities. We encourage you to promote the integration to mutual customers and prospects.

For ideas and resources, see [Learn How to Promote Your Integration](/docs/partner-guide/integrate-with-us/publish-integration/promote-integration).

<Check>
  **Thank you for partnering with MoEngage!**

  We're excited to see the integrations you build. If you have questions at any stage, reach out to your partner manager or email [partnerships@moengage.com](mailto:partnerships@moengage.com).
</Check>