Introduction

Streams allow you to forward events such as user actions, campaign interaction events, and so on available in MoEngage to a predefined API endpoint in near real-time.

With MoEngage Streams, you can configure your API endpoint, define the events that you want to be forwarded, and once done, see a stream of data flowing to your system. You can then utilize the data to enrich your data warehouses and recommendation systems.

Popular Use Cases for MoEngage Streams

The following are a few popular use cases for Streams:

• Enrich the central data warehouse with MoEngage events such as Notification Clicked Android, Email Clicked, SMS Clicked, and so on.
• Forward the Conversion Events such as Purchase, Song Played, Bill Payment Done, and so on from MoEngage to the external Analytics tool.
• Feed campaign interaction events from MoEngage to your recommendation system.
• Export the notification interaction data from MoEngage to our machine learning (ML) system for optimizing the performance of our algorithms.
• Send all user events present in MoEngage to an external own data lake.

Enable Streams for Your Account

Please reach out to your Customer Success Manager to get this enabled for your account. Note that Streams is only available as a part of a few pricing plans and you can include this separately when required.

Set Up Streams

Streams can export data to your API endpoint or one of the partners integrated with MoEngage.

Set Up Streams for Exporting Data to Your API Endpoint

To export data from MoEngage to your servers, you must raise a support ticket with the following information:

1. API endpoint to send the data. It can be something like https://api.example.com/events.
2. List of events that need to be sent to this API endpoint. A list of campaign events available for export is mentioned in the next section.
3. List of user attributes and device attributes that need to be sent to the API endpoint with each event.
4. If you need all campaign interaction events, we will export such events as mentioned in the next section.

You can use the following template to raise a Streams enablement request:

Hey!

Please enable Streams for my Workspace.
      
Workspace Region: DC-01/DC-02/DC-03/DC-04
Workspace Name: MyWorkspace
Workspace ID: <my-workspace-id>

API Endpoint: https://www.example.com/api?url_param1=vaue1

Headers:
header1: value1
header2: value2

Authentication:
Method: No auth/Basic Auth
[Only for basic auth] Basic Auth username: "Username"
[Only for basic auth] Basic Auth password: "Password"

Events to export: All/List of events
[Optional] List of events: List of events to export

User properties to export: All/List of user properties
[Optional] List of user properties: List of user properties to export

Set Up Streams for Exporting Data to Partners

With Streams, you can export data directly to integrated partners so that you can enrich your marketing/analytics activities on these platforms. As of now, Streams can export data to the following partners:

• Mixpanel
• Amplitude
• Segment
• mParticle
• Rudderstack

Please follow partner-specific integration documents for setting this up.

Campaign Interaction Events

The following is a list of Campaign Interaction Events that MoEngage generates, which you will often need to be sent to your API endpoint:

• With the events above, the following event attributes will be exported by default:
  • campaign_id
  • campaign_name
  • campaign_type
  • campaign_channel
• The following event attributes are not supported for export in streams currently:
  • email_subject
  • email_click_url
  • inapp_widget_clicked
  • onsite_message_url_clicked

For more information on when the campaign events and attributes are tracked, refer to this article.

Authentication Methods

Streams supports the following types of authentications:

• No auth
• Basic Auth: Streams supports the standard Basic Auth implementation. You must provide us with the username and password while configuring Streams. All data related to authentication is always encrypted in our systems.

To support other authentication methods such as API Key, Bearer Token, and so on, you can communicate the same through the enablement ticket and provide us the Header key and static value to be passed. We will not be able to support dynamically refreshing API keys and tokens.

API Request Format

When Streams sends an event to your API endpoint, the request format will be as below: 

Headers:

"Content-Type" : "application/json"

Request Body:

{
    "app_name": "App Name",
    "source": "MOENGAGE",
    "moe_request_id": "moengage unique request id for each request",
    "events": [{
        "event_name": "Notification Received Android",
        "event_code": "NOTIFICATION_RECEIVED_MOE",
        "event_uuid": "moengage unique id for each event",
        "event_time": 1580967474,
        "event_type": "CAMPAIGN_EVENT",
        "event_source": "MOENGAGE",
        "push_id": "recipient device’s push token",
        "uid": "<MoEngage customer_id>",
        "event_attributes": {
            "campaign_id": "353df897hkbh67658",
            "campaign_name": "Name of the Campaign",
            "campaign_type": "Event Trigger",
            "campaign_channel": "Push"
        },
        "user_attributes": {
            "moengage_user_id": "moe_internal_user_id",
            "user_attr_1": "user_attr_val1",
            "user_attr_2": "user_attr_val2"
        },
        "device_attributes": {
            "moengage_device_id": "moe_internal_device_id",
            "device_attr_1": "device_attr_val1",
            "device_attr_2": "device_attr_val2"
        }
    }, {
        "event_name": "Email Sent",
        "event_code": "MOE_EMAIL_SENT",
        "event_uuid": "moengage unique id for each event",
        "event_time": 1580967474,
        "event_type": "CAMPAIGN_EVENT",
        "event_source": "MOENGAGE",
        "email_id": "recipient email_id",
        "uid": "<MoEngage customer_id>",
        "event_attributes": {
            "campaign_id": "353df897hkbh67658",
            "campaign_name": "Name of the Campaign",
            "campaign_type": "General",
            "campaign_channel": "Email"
        },
        "user_attributes": {
            "moengage_user_id": "moe_internal_user_id",
            "user_attr_1": "user_attr_val1",
            "user_attr_2": "user_attr_val2"
        },
        "device_attributes": {
            "moengage_device_id": "moe_internal_device_id",
            "device_attr_1": "device_attr_val1",
            "device_attr_2": "device_attr_val2"
        }
    }, {
        "event_name": "SMS Delivered",
        "event_code": "SMS_DELIVERED",
        "event_uuid": "moengage unique id for each event",
        "event_time": 1580967474,
        "event_type": "CAMPAIGN_EVENT",
        "event_source": "MOENGAGE",
        "mobile_number": "recipient mobile number",
        "uid": "<MoEngage customer_id>",
        "event_attributes": {
            "campaign_id": "353df897hkbh67658",
            "campaign_name": "Name of the Campaign",
            "campaign_type": "Event Trigger",
            "campaign_channel": "SMS"
        },
        "user_attributes": {
            "moengage_user_id": "moe_internal_user_id",
            "user_attr_1": "user_attr_val1",
            "user_attr_2": "user_attr_val2"
        },
        "device_attributes": {
            "moengage_device_id": "moe_internal_device_id",
            "device_attr_1": "device_attr_val1",
            "device_attr_2": "device_attr_val2"
        }
    }]
}

Streams Data Glossary

The keys in the API request and their description are:

Whitelist IPs

If your endpoints are in a VPC/are not accessible publicly, you must whitelist the following MoEngage IPs depending on the region of your Workspace:

Limitations

Please be aware of the following constraints or limitations while integrating Streams with third-party apps.

• We can send data to only one static endpoint where the access token or link has no expiry. We cannot integrate it on a dynamic endpoint where the access token is refreshed every few hours.
• We cannot modify the body or key names while streaming the data from MoEngage.

Frequently Asked Questions