Streams

​

Use Cases for MoEngage 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 your machine learning system for optimizing the performance of your algorithms.
• Send all user events present in MoEngage to an external data lake.

​

Campaign Interaction Events

• 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.

​

API Request Format

{
    "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"
        }
    }]
}

​

Streams Data Glossary

​

Authentication Methods

• No auth
• Basic Auth: Streams supports the standard Basic Auth implementation. You must provide MoEngage with the username and password while configuring Streams. MoEngage always encrypts all authentication data in its systems.
• OAuth 2.0: Streams supports OAuth 2.0 authentication using the Client Credentials grant type, where MoEngage fetches and refreshes the access token for you. A self-serve option to select OAuth 2.0 directly in Streams is not yet available. For setup steps, refer to Configure OAuth 2.0 for Streams.

​

Configure OAuth 2.0 for Streams

1

Create an OAuth 2.0 configuration

Navigate to Settings > Advanced settings > Authorization configuration and add an OAuth 2.0 configuration using the Client Credentials grant type. Provide the token endpoint, credentials, and response settings for your authorization server. For the full walkthrough, refer to Authorization Configuration with OAuth 2.0.

2

Confirm the configuration is active

Save the configuration and verify that its status is Active on the Authorization configuration page. A “Failed” configuration cannot fetch a token and cannot be used for Streams.

3

Note the OAuth configuration ID

Open the OAuth 2.0 configuration you created. The configuration ID is the last segment of the page URL. For example, if the URL is .../advanced/auth-config/edit/69242b6047c75584338719e5, the configuration ID is 69242b6047c75584338719e5. Copy this ID to include in the enablement ticket.

4

Raise a support ticket to enable OAuth 2.0 for Streams

Follow the steps in Enable Streams for Your Account and include the OAuth configuration ID so that the Support team can link your OAuth 2.0 configuration to your Streams endpoint.

​

Enable Streams for Your Account

​

Set Up Streams for Exporting Data to Your API Endpoint

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 Campaign Interaction Events 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, MoEngage exports such events as mentioned in the Campaign Interaction Events section.

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](https://www.example.com/api?url_param1=vaue1)

Headers:
header1: value1
header2: value2

Authentication:
Method: No auth/Basic Auth/OAuth 2.0
[Only for basic auth] Basic Auth username: "Username"
[Only for basic auth] Basic Auth password: "Password"
[Only for OAuth 2.0] OAuth configuration ID: "<oauth-config-id>"

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

• Mixpanel
• Amplitude
• Segment
• mParticle
• Rudderstack

​

Stream Events to Another MoEngage App

• Cross-Product Promotions: If you have teams across various product offerings, keeping two apps synced helps you cross-promote products to upsell and increase conversion.
• Centralized Analysis: Businesses with multiple apps can run cross-app analysis to unlock higher LTV, cross-sell, and increase brand loyalty.

​

Limitations

• MoEngage can send data to only one static endpoint. If the access token expires, use an OAuth 2.0 configuration so that MoEngage can fetch and refresh the token for you (see Authentication Methods). For any other authentication method, MoEngage cannot integrate with an endpoint where the access token or link expires or is refreshed every few hours.
• MoEngage cannot modify the body or key names while streaming the data.

​

Frequently Asked Questions