✳️ Additional Channels

(Use this example if your integration uses MoEngage Connector Campaigns to send data to your API endpoints, such as for voice, direct mail, or calendar events.)

[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: Additional Channels

Overview 🚀

(Explain the integration's core function. Describe how marketers can use MoEngage's segmentation and campaign triggers to send data to your platform's API, initiating actions like sending a voice call, mailing a postcard, or creating a calendar event.)

The MoEngage and [Partner Name] integration allows you to use MoEngage Connector Campaigns to trigger real-time, automated actions on our platform. By sending user and event data from MoEngage to [Partner Name]'s API, marketers can seamlessly orchestrate campaigns on additional channels like voice, direct mail, or calendar events as part of a unified customer journey.

This enables you to engage users on unique, high-impact channels based on their behavior, extending your marketing automation beyond traditional digital messages.

Use Cases 🎯

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

Send Automated Voice Call Reminders: Trigger an event-based connector campaign in MoEngage to send an automated voice call via [Partner Name] for appointment reminders or order updates.
Mail a Promotional Postcard: When a user enters a "High-Value Customer" segment in MoEngage, trigger a webhook to [Partner Name] to automatically send them a personalized direct mail postcard with a special offer.
Create Dynamic Calendar Events: After a user purchases a ticket, send event details from MoEngage to [Partner Name] to create a personalized calendar event and add it to the user's calendar.

Prerequisites ✅

(List everything a user must have before starting. Be explicit about required account credentials from your platform, such as API Keys, Account IDs, or authentication tokens.)

An active MoEngage account.
An active [Partner Name] account.
Your API credentials from the [Partner Name] dashboard, such as:
- API Key and API Token or Secret
- Account SID or Account ID
- Any other required identifiers for the API endpoint.

Integration Setup 🛠️

(This is the most critical section. It should be a two-part guide: first, how to get the necessary credentials from your platform, and second, how to configure the Connector Campaign in MoEngage to call your API. Provide specific examples and screenshots.)

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

(Provide clear, step-by-step instructions on where the user can find their API endpoint URL, API keys, and any other necessary credentials from your dashboard. Screenshots are highly recommended.)

Log in to your [Partner Name] dashboard.
Navigate to the API Settings or Developer section.
Locate and copy the following:
- API Key / App ID: [Explain where to find this]
- API Token / Secret: [Explain where to find this]
- Account SID / Identifier: [Explain where to find this]

Step 2: Set up a Connector Campaign in MoEngage

On the left navigation menu in the MoEngage UI, go to Create Campaign > Connectors > Custom.
Choose a delivery type (e.g., event-triggered, scheduled) and proceed to the second step of campaign creation ("Webhook").
Configure the API call to your platform:

Field	Configuration Instructions	Example
Webhook URL	Enter your API endpoint. Use {{...}} syntax to include dynamic data (like a User ID or an Account Code) in the URL if your endpoint requires it.	https://api.partner.com/v1/send-voice-call
Method	Select the appropriate HTTP method.	POST
Headers	Add necessary headers for authentication and content type. (Provide the exact Header Keys and explain how to format the Values, especially for Basic Auth.)	Key: `Authorization` Value: `Basic <YOUR_ENCODED_API_KEY_AND_SECRET>` Key: `Content-Type` Value: `application/json`
Body	Select Raw and provide the complete JSON payload required by your API. Use MoEngage's personalization syntax (`{{UserAttribute['...']}}` or `{{EventAttribute['...']}}`) to send dynamic user or event data. (Crucial: Provide a well-commented, real-world JSON example for a primary use case.)	See example payload below.

Example JSON Payload:

{
  // The mobile number of the user to call
  "to": "{{UserAttribute['Mobile Number']}}", 
  
  // The Caller ID configured in your Partner account
  "from": "18005551234", 
  
  // The message to be read out, personalized with user's name
  "message": "Hello {{UserAttribute['First Name']}}, this is a reminder for your appointment tomorrow.",
  
  // Unique identifier for the transaction
  "transaction_id": "{{EventAttribute['appointment_id']}}"
}

Use the Test functionality to send a sample request to your endpoint and verify the configuration. A successful test should result in a 200 OK response.
Once validated, you can publish the connector campaign.

Troubleshooting & FAQs❓

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

For example:

Issues:

Example Issue: The Connector test fails with a 401 Unauthorized error.

Verify Authentication Headers: Double-check that the Authorization header is correctly formatted. If using Basic Auth, ensure the key and secret are combined and Base64 encoded properly. Confirm the API Key and Secret are correct and have not expired.

FAQs:

How can I check if the API call from MoEngage was successful?
Answer: [Specify where to check]. For example: "You can view the API call logs in your [Partner Name] dashboard under the 'API Logs' or 'Developer' section to see the incoming request from MoEngage and the corresponding status."
Are there rate limits for your API?
Answer: [Provide details on API rate limits]. For example: "Yes, our API has a default rate limit of 100 requests per minute. Please contact our support team if you require a higher limit."
Who should I contact if my issue is not resolved?
Answer: For issues related to API errors, authentication, or action failures on our platform, contact our support team at [Partner Support Email/Link]. For issues related to MoEngage campaign setup, segmentation, or personalization syntax, contact your MoEngage 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.