Introduction

Streams allow you to forward events like user actions, campaign interaction events, and so on available in MoEngage to a pre-defined 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, which you can then utilize to enrich your data warehouses and recommendation systems, and so on.

Popular Use-cases for MoEngage Streams

A few popular use cases for Streams are as below:

• • • Enrich the central data warehouse with MoEngage events like Notification Clicked Android, Email Clicked, SMS Clicked, and so on.
    • Forward the Conversion Events like 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 ML system for optimizing the performance of our algorithms.
    • Send all user events present in MoEngage to an external own data lake.

Enabling Streams for your account

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

Setting up Streams

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

Setting up Streams for exporting data to your API endpoint

1. 1. 1. API Endpoint to send the data. It could be something like https://api.example.com/events
      2. List of events that need to be sent to this API endpoint.
      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.

Setting 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:

1. 1. 1. Mixpanel
      2. Amplitude
      3. Segment
      4. mParticle

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

Campaign Interaction Events

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

With the above events, 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 right now - email_subject, email_click_url, inapp_widget_clicked, onsite_message_url_clicked.
For more information on when the campaign events and attributes are tracked, please refer to this article.

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 is as below:

Limitations

Please be aware of the following constraints/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.