🎯 Connected Channels

(Use this example if your integration adds a new messaging channel or data sync channel to MoEngage or is built on the Connected Channels framework.)

[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: [Your Partner Category]

Overview 🚀

(Explain the core value of the integration. Describe how marketers can use MoEngage's segmentation and campaign triggers to send messages or sync audiences to your channel. Keep it high-level and benefit-oriented.)

The MoEngage and [Partner Name] integration plugs your powerful channel directly into the MoEngage customer engagement engine. This allows marketers to orchestrate brilliant, omnichannel journeys and connect with users on your platform using MoEngage's advanced segmentation, personalization, and analytics.

By activating [Partner Name] as a channel, brands can go beyond traditional marketing to deliver rich, interactive experiences that capture attention and drive action.

Use Cases 🎯

(List the 2-3 primary things users can achieve with this integration. Be specific and action-oriented.)

For Messaging Channels:

Send Rich Promotional Offers: Deliver visually engaging promotions with images, videos, and interactive buttons that drive higher conversions.
Trigger Timely Transactional Notifications: Instantly notify users about order confirmations or shipping updates on the channel they use most.

For Ad Audience Channels:

Build Hyper-Targeted Ad Campaigns: Sync custom segments from MoEngage to create powerful lookalike audiences or retarget high-value users on your platform.
Create Suppression Lists to Optimize Ad Spend: Exclude specific user segments (like recent purchasers) from ad campaigns to improve efficiency and ROI.

Prerequisites ✅

(List everything a user must have before starting. Be explicit about required business accounts, authentication tokens, OAuth app credentials, and any specific user IDs.)

An active [Partner Name] Business Account (e.g., a "Viber Bot," "LINE Official Account," or "Snapchat Ads Account").
Your Authentication Credentials from the [Partner Name] developer console or admin panel (e.g., Bot Token, Channel Access Token, OAuth Client ID & Secret).
A method to collect your users' [Partner Name] User IDs (e.g., viber_id, telegram_chat_id), if required for your integration. (remember to specify how customers can capture these IDs and store them in MoEngage as user attributes)

Integration Setup 🛠️

(Guide the partner through the complete setup flow, from getting user IDs to launching a campaign. The steps below reflect the common pattern for Connected Channel integrations.)

Step 1: Configuration on the [Partner Name] Platform (If Applicable)

(This step is crucial for integrations that require setup on your end first, like creating an OAuth App.)

(Please provide clear, step-by-step instructions for any necessary setup within your platform's dashboard. Include screenshots where possible.)

Example for Ad Partners:

Log in to your Business Manager and create a new OAuth App.
In the app settings, add the MoEngage Redirect URI for your data center.
Generate and copy your Client ID and Client Secret.

Step 2: Set up the [Partner Name] Connector in MoEngage

In the MoEngage dashboard, navigate to App Marketplace.
Search for [Partner Name] and click on the tile.
Go to the Integrate tab and click + Add connection.
Fill in the connection details:

Field	Required	Description
Connection name	Yes	A friendly name to identify this connection.
[Auth Credential 1]	Yes	(Provide the exact name, e.g., "Bot Token" or "Client ID"). Instruct the user to paste the credential.
[Auth Credential 2]	Yes	(Provide the exact name, e.g., "Client Secret").

Click Connect to save the configuration.

Step 3: Create a [Partner Name] Campaign in MoEngage

Navigate to Create Campaign > Connected Apps > [Partner Name].
Choose your delivery type and select your target audience.
[Crucial Targeting Rule: If your integration uses a specific user ID, instruct users to add a filter to target users where [your_partner_id] exists.]
On the campaign creation screen, configure the connector.

(Choose the option below that fits your integration.)

Option A: For Sending a Message

(Detail out the available connectors for your channel, along with each of their fields in the campaign form.)

Field	Description
Connector	Select the desired action, e.g., `Add Users to Customer List` or `Remove Users from Customer List`.\|
Connections	Select the [Partner Name] connection you created.
Receiver ID	Map this to the MoEngage user attribute where the ID is stored. Example: `{{UserAttribute['[partner_name]_id']}}`.
Message Content	(Detail the different message types you support, e.g., Text, Image, Video, Buttons, and the fields required for each.)

Option B: For Syncing an Audience

(Detail out the available connectors for your channel, along with each of their fields in the campaign form.)

Field	Description
Connector	Select the desired action, e.g., `Add Users to Customer List` or `Remove Users from Customer List`.\|
Connections	Select the [Partner Name] connection you created.
Customer List ID	The ID of the audience list on your platform where users should be synced.
User Identifiers	(Detail which user attributes (e.g., Email, Google Advertising ID) should be mapped to sync users.)

Use the Test functionality to send a sample request and verify your setup.
Once validated, publish your campaign!

Troubleshooting & FAQs❓

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

For example:

Example Issue: Test message fails, or the audience is not updated.

Missing User ID: For messaging channels, verify that the test user has a value for the [partner_name]_id attribute.
Incorrect Audience ID: For ad channels, ensure the Customer List ID is correct and the ad account has the right permissions.
User Consent: Confirm the user has subscribed to your bot/business account and has not blocked you.

FAQs:

How do I get the [Partner_Name]_id for my users?
Answer: [Provide a brief summary and link to your developer docs on getting user identifiers.]
What rich media formats do you support?
Answer: [List supported formats, e.g., JPG, PNG, MP4, and any size/resolution limits.]
How long does it take for the audience to reflect on your platform after syncing?
Answer: [Provide an estimated time frame, e.g., "Audiences may take up to 24 hours to fully populate."]

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.