Overview

All user events and campaign events that have been received or generated by MoEngage can be exported using S3 Exports. The exported data can be analyzed further to glean insights into user behavior, preferences, and what have you.

S3 Integration for Data Exports

S3 is a highly scalable storage system offered by Amazon Web Services. Integration with the S3 buckets will allow MoEngage to share periodic exports of required data in JSON format. To get started with S3 integration, follow the below steps:

Step 1: Create S3 Bucket

Even if you have an S3 bucket already, we still recommend creating a new bucket specifically for MoEngage so you can limit permissions.

1. To create a bucket for your app, open theS3 console and follow the instructions to Sign in or Create an Account with AWS.
2. Once signed in, select “S3” from the “Storage Content Delivery” category.
3. Select “Create Bucket” on the next screen and you will be prompted to create your bucket and select a region.

Step 2: Create Policy

{
    "Version": "2012-10-17",
    "Id": <INSERTPOLCIYID>,
    "Statement": [
        {
            "Sid": <INSERTSID >,
            "Effect": "Allow",
            "Principal": {
                "AWS": "arn:aws:iam::612427630422:role/service-role/core_s3_export-role-e1qw8ulf"
            },
            "Action": "s3:PutObject",
            "Resource": "arn:aws:s3:::<INSERTBUCKETNAME>/*"
            }
        ]
}

Step 3: Enable S3 Exports on the MoEngage App Marketplace

To create a new S3 Buckets connection, perform the following steps:

1. On the left navigation menu in the MoEngage dashboard, click App marketplace.
2. On the App marketplace page, in the search bar, type Amazon S3.
3. Click the Amazon S3 tile.
4. On the Amazon S3 page, click the Integrate tab, and then click + Add connection.
   
5. Enter S3 bucket connection details.
   
   

   Field	Description	Example
   Connection name	This is the name of the connection. Enter a unique and identifiable name.	My S3 Export
   Bucket name	This is the name of your S3 bucket. How do I find the bucket name? In your AWS console, go to S3 and select your bucket from the list. The bucket's name is mentioned at the top. You can also find this in your bucket Properties tab. In your S3 ARN, the part after arn:aws:s3::: is your bucket name:	test-bucket
   Folder path	This is the path of the folder in which your files are dumped. Do not begin or end with a slash. The final path of the dump is: s3://<your-bucket-name>/[<folder_path>_]<connection_name>/export_day=<DD-MM-YYYY>/event_exports_<export_timestamp>.json.gz The export timestamp is the EPOCH timestamp of when the file was generated in the UTC timezone. Your final path is displayed on the UI for your confirmation. How do I find the folder path? From the list of objects in your S3 bucket, open the folder in which you want to dump the files. On the Properties tab, look at the folder's S3 URI. Your folder path is the part after s3://[your-bucket-name]/ excluding the trailing slash. In the example above, your folder path is my-dump/to_import	my_folder my_folder/sub_folder
   Bucket region	This is the name of your S3 bucket. How do I find the bucket region? In your AWS Console, go to S3 and select your bucket from the list. The bucket's name is mentioned at the top. You can also find this in your bucket Properties tab. Look at your S3 ARN, the part after arn:aws:s3::: is your bucket name:	Asia Pacific (Mumbai) (ap-south-1)
   Select events	Select which events you want to export to your S3 buckets. You can choose to export All events (existing and new events coming into MoEngage in the future) or select events manually and export only those events.
   User properties	You can select which user properties (user properties and device properties) you want to export with your events.
   Frequency	Select how often you want to export these events. MoEngage offers three frequencies: Every 15 minutes: MoEngage dumps files at 15-minute intervals. Daily: MoEngage dumps files at the end of each day, 00:00 UTC. Weekly: MoEngage dumps files every Monday at 00:00 UTC. Warning: Frequently changing your export frequency is not recommended, which might result in data loss or duplication.
   File Encryption	MoEngage supports exporting encrypted files. Currently, it only supports PGP encryption. If you want to export encrypted files, turn the File Encryption toggle on. MoEngage will encrypt the GZIPPED file with the provided public key and append the extension of .gpg. After decrypting the file, unzip it to view the files exported. You can then view them normally. For example: event-exports_1735198203.json.gz.gpg
   Encrypt Key	If the File Encryption toggle is turned on, you must enter your PGP Public Key in the Encrypt Key section. MoEngage will use this key to encrypt all files it exports, but you must handle the decryption mechanism at your end. For example: -----BEGIN PGP PUBLIC KEY BLOCK----- xqq74BCADKpWRLSAdcTtD45nl24KpT+LCUCqDoZQ2dlgeBiXNovBVyTPlAOPQSqX bnNGs+U4RpHebjvTxaWCLDBGYOvtZbtv6WvPIF7lzXrIv+DcgLMBQp2b3t+ohRBi 41Ch8CZ04F2lxboksCwnl31laEuQkk8MERlcthB9AiKvSEf6jihLcPSVVanrQUQN77UZf sFCynJXweqijZxtmUl9V1838sUVOoTzfmGwu7PzV99tAiOlxBjYF9SXIYY/GOoJN Zuz8uOaXWtFPmV536uQT -----END PGP PUBLIC KEY BLOCK-----

6. Click Test Connect to test your details.

Upon clicking Test Connect, MoEngage attempts to verify the credentials. You can also directly click Connect to proceed. After the setup is complete, the files are dumped into the specified folder path based on your selected export frequency.

Events and attributes

With the MoEngage and S3 integration, you can export all events coming into MoEngage to your S3 buckets. By default, MoEngage tracks some standard events and user properties through its SDKs. You can read about our standard events and attributes here. You can also export any custom user-defined event you tracked in MoEngage.

Data Export Format

File Format: JSON

Compression Type: GZip

Export Frequency: Every 15 mins / Daily / Weekly

Sample Folder Path:

s3://<your-bucket-name>/[<folder_path>_]<connection_name>/export_day=<DD-MM-YYYY>/event_exports_<export_timestamp>.json.gz

The <export_timestamp> is the EPOCH timestamp of when the file was generated in the UTC timezone.

Sample Export Data

    {
        "app_name": "App Name",
        "export_hour": "10",
        "db_name": "MoEngage App Name",
        "event": {
            "uid": "user id",
            "event_type": "USER_ACTION_EVENT",
            "event_code": "VIEW_RADAR",
            "event_name": "VIEW_RADAR",
            "user_attributes": {
                "moengage_user_id": "userid1",
                "user_attr1": "value1",
                "user_attr2": "value2"
            },
            "event_source": "MOENGAGE",
            "event_attributes": {
                "event_attr1": "value1",
                "event_attr2": "value2"
            },
            "event_uuid": "62045d15-8d5e-4cfd-ac49-5919bffb401d",
            "event_time": 1652820710,
            "device_attributes": {
                "moengage_device_id": "device id"
            }
        },
    		"export_day": "2022-05-20"
    }
    

    {
    "app_name": "App Name",
    "export_hour": "6",
    "db_name": "MoEngage App Name",
    "event": {
        "uid": "user id",
        "event_type": "CAMPAIGN_EVENT",
        "event_code": "MOE_EMAIL_SENT",
        "event_name": "Email Sent",
        "user_attributes": {
            "moengage_user_id": "userid1",
            "user_attr1": "value1",
            "user_attr2": "value2"
        },
        "event_source": "MOENGAGE",
        "email_id": "test@xyz.com",
        "event_attributes": {
            "campaign_name": "Campaign name",
            "moe_campaign_tags": [
                "Tag1",
                "Tag2"
            ],
            "campaign_type": "GENERAL",
            "moe_campaign_channel": "Email",
            "moe_delivery_type": "One Time",
            "campaign_id": "moengage campaign id",
            "campaign_channel": "EMAIL"
        },
        "event_uuid": "3b918064-08dc-47ae-b674-c23797475a8d",
        "event_time": 1653022310,
        "device_attributes": {
            "moengage_device_id": "device id if applicable"
        }
    },
    "export_day": "2022-05-20"
}

You can download a sample file from here. This is a GZIPPED file and needs to be extracted before the files can be viewed.

Integrate AWS Key Management Service with Amazon S3

1. Create an AWS Key Management Service (KMS) Customer Master Key (CMK) using the AWS Management Console, AWS CLI, or AWS SDKs. You can skip this step if your AWS KMS is already generated.
2. Enable the AWS KMS key for use with S3 by adding permissions to the AWS KMS key policy. Here is an example key policy allowing the key to be used for S3 encryption:
   
   Code

   {
   
   "Version": "2012-10-17",
   
   "Id": "key-policy",
   
   "Statement": [
   
   {
   
   "Sid": "Allow use of the key for S3 encryption",
   
   "Effect": "Allow",
   
   "Principal": {
   
   "AWS": "arn:aws:iam::612427630422:role/service-role/core_s3_export-role-e1qw8ulf"
   
   },
   
   "Action": [
   
   "kms:Encrypt",
   
   "kms:Decrypt",
   
   "kms:ReEncrypt*",
   
   "kms:GenerateDataKey*",
   
   "kms:DescribeKey"
   
   ],
   
   "Resource": [
   
   "arn:aws:s3:::your-bucket",
   
   "arn:aws:s3:::your-bucket/*"
   
   ]
   
   }
   
   ]
   
   }

3. Configure the S3 bucket to use the AWS KMS key for encryption. You can do this while creating the bucket or modifying the bucket's properties.
4. Under the S3 Management Console, navigate to the bucket where we want to enable server-side encryption.
5. Click the Properties tab and scroll down to the Default encryption section.
6. Select the Server-side encryption with AWS Key Management Service keys (SSE-KMS) option for "Encryption" and select the AWS KMS key you created from the drop-down menu. Use only your KMS key's AWS KMS ARN.
7. Click Save to apply the encryption configuration to the bucket. Your S3 objects will be automatically encrypted using the AWS KMS key you integrated.
8. We require the AWS KMS Key ARN, so kindly provide it to us. We must whitelist it from MoEngage's end.

Frequently Asked Questions