CategoriesView All

Event

Amazon Simple Queue Service (Amazon SQS) offers reliable and scalable hosted queues for storing messages as they travel between computers. By using Amazon SQS, you can move data between distributed components of your applications that perform different tasks without losing messages or requiring each component to be always available.

Supported Features

  • Event Forwarding

Prerequisites

In order to take advantage of the Amazon SQS integration, you’ll need the SQS Queue URL and the credentials of an Identity and Access Management (IAM) user that has access to SQS. Refer to the links below for Amazon setup:

Click here for information on SQS ARN syntax. Sample ARN syntax for SQS is: arn:aws:sqs:region:account-id:queuename.

{
   "Version": "2012-10-17",
   "Statement": [
       {
           "Effect": "Allow",
           "Action": [
               "sqs:SendMessage"
           ],
           "Resource": [
               "arn:aws:sqs:{region}:{account-id}:{queuename}"
           ]
       }
   ]
}

Refer to the steps below for Amazon setup:

  1. Create an SQS Queue
  • Click on the new SQS Queue and the Queue URL will be shown in the details tab - the SQS Queue URL is required for mParticle setup
  1. Create an IAM user
  • Be sure to save the credentials file which contains the Access Key Id and Secret Access Key required for mParticle setup.
  1. Create a Custom Policy. Use one of the following methods to create the policy:

    1. Manual Policy Creation
    • Select Amazon SQS as the AWS Service
    • Include the following actions: SendMessage
    • Enter the ARN (available on the details tab of the SQS Queue)
    • Click Add Statement
    1. Create Policy from JSON

      • Paste the template policy above into the “Policy Document” field. Be sure to replace the {region}, {account-id} and {queuename} with your specific values.
  2. Assign Customer Policy to User

Event Data Format

The event data will be forwarded as JSON objects. Please refer to the JSON documentation for a detailed description of the data format.

Configuration Settings

Setting Name Data Type Default Value Description
Access Key ID string This is your IAM user’s Access Key Id, which can be found on your IAM dashboard, or in the credentials.csv file that you might have downloaded after creating the IAM user.
Secret Access Key string This is your IAM user’s Secret Access Key, which can be found in the credentials.csv file that you might have downloaded after creating the IAM user.

Connection Settings

Setting Name Data Type Default Value Platform Description
Queue URL string All This is your SQS queue URL.
Unique ID string All An optional string identifier for your app that will be forwarded with each event batch. Standard app identifiers (Apple OS Bundle ID, Android Package Name) will be forwarded regardless of this setting.
Send Lifecycle Events bool True All If enabled, lifecycle events (application start/stop, session start/end) will be forwarded.
Send Screen Views bool True All If enabled, screen view events will be forwarded.
Send Crash Events bool True All If enabled, app crashes will be forwarded.
Send Network Performance Events bool True All If enabled, network performance events will be forwarded.
Send Custom Events bool True All If enabled, custom app events will be forwarded.
Send Push Registrations and Receipts bool True All If enabled, push registration and receipt notifications will be forwarded.
Send as Batch bool True All If enabled, this setting will cause your app’s events to be sent in (roughly) 10-minute batches per device. If disabled, mParticle will POST each event to you individually, as its received. This setting is ignored if “Wait for Complete Batch” is enabled.
Wait for Complete Batch bool False All If enabled, mParticle will POST events to you in batches only after a user session has ended, so that each event batch you receive will represent a full session of user activity within your app.
Include Location Information bool True All If enabled, location data will be forwarded with event data whenever possible.
Include User Identities bool True All If enabled, user identity information will be forwarded with event batches.
Send Profile Change Events bool True All If enabled, mParticle will forward ID profile events, such as user sign ups, logins logouts, updates, and deletes.
Send Commerce Events bool True All If enabled, commerce events will be forwarded.
Include Metadata bool True All If enabled, the following metadata - application_info, device_info and source_info will be forwarded.
Include User Attribute Change Events bool False All If enabled, User Attribute Change Events will be forwarded.
Include User Identity Change Events bool False All If enabled, User Identity Change Events will be forwarded.