Create Event

The Create Event API allows you to track the actions of a user.

API Endpoint

URL
POST https://api-0X.moengage.com/v1/event/<APP_ID>

The 'X' in the API Endpoint URL refers to the MoEngage Data Center (DC). MoEngage hosts each customer in a different DC. You can find your DC number (value of X) and replace the value of 'X' in the URL by referring to the DC and API endpoint mapping here.

info

Note

The APP_ID for your MoEngage account is available on the MoEngage Dashboard. We've revamped our settings UI; you can find the APP_ID in the following navigations in the revamped and old UIs:

    • Revamped UI: Settings -> Account -> APIs -> App ID
    • Old UI: Settings -> App Settings -> Account Settings -> APP ID

 

Authentication

The API request will be authenticated through Basic Authentication. Basic Authentication sends a Base64-encoded string containing your username and password with every API request. It encodes a 'username:password' string in Base64 and appends the encoded string with 'Basic '. This string is included in the authorization header as shown below:

{"Authorization":"Basic bmF2ZWVua3VtYXI6bW9lbmdhZ2U="}

The username and password details can be obtained from the MoEngage Dashboard. We've revamped the settings UI in the Dashboard. If you're using the API for the first time, follow these steps for the revamped and old UIs:

Revamped UI

  1. Navigate to Settings -> Account -> APIs.
  2. Click Generate Key in the Data tile in the API Keys section, and click Save.
  3. Use the App ID as the username and the Data API Key as the password to generate the authentication header.

Old UI

  1. Navigate to Settings -> APIs -> DATA API Settings.
  2. Click Generate Key.
  3. Click Save on the Data APIs settings section. 
  4. Use the DATA API ID as the username and the DATA API KEY as the password to generate the authentication header.

Request Parameters

Key Mandatory/Optional Data String Description

app_id

Mandatory

String

This is your MoEngage account's APP ID that has to be passed along with the request. You can find your MoEngage APP ID in the following navigation on the Dashboard:

Revamped UI: Settings > Account > APIs > App ID

Old UI: Settings > API > General Settings > DATA API

 

Request Headers

Key Mandatory/Optional Sample Values Description

X-Forwarded-For

Mandatory

Header Value Format: <IP Address>

The 'X-Forwarded-For' header is used to specify the IP address of the client that made the request. This header may be added by proxy servers or load balancers. The header value must contain the IP address of the original client that initiated the request. Multiple IP addresses may be specified in the header value, separated by commas. (This is optional)

Content-Type

Mandatory

{"Content-Type": "application/json"}

Set the Content-Type header to application/json.

Authorization

Mandatory

{"Authorization": "Basic bmF2ZWVua3VtYXI6bW9lbmdhZ2U=="}

This authentication parameter, used for access control, must be passed along with the request. To generate the authentication header, refer to Authentication.

Request Body

info

Note

You can not use "moe_" as a prefix while naming events, event attributes, or user attributes. It is a system prefix and using it might result in periodic blacklisting without prior communication.

 

Request Body Fields

Key Datatype Required Description
type String Yes This is used to identify the type of request. 

Allowed Value: event

Example: "type": "event"

Note: This field is case-sensitive. Follow the case as in the example when passing the value in the request.

customer_id String Yes Identifier to identify or create a user in MoEngage.
device_id String No device_id in event payload is optional. The default value is the customer_id value. The value is used to map events to specific devices.
actions List Yes List of events to be tracked for the user.
action String Yes The name of the event to be tracked.
attributes JSON Object No A dictionary containing event attributes to track with the event.
platform String No Used to identify the platform on which the event happened. Allowed values are ANDROID, iOS, web, or unknown.
app_version String No App Version of the app on which the event originated.
user_time Numeric (Epoch time in seconds) or String (ISO 8601) No Local time at which the event happened.
current_time Numeric (Epoch time in seconds) or String( ISO 8601) No UTC time at which the event happened.
user_timezone_offset Numeric No

The difference in time between UTC and the local system time in a particular time zone. All time zones are defined by their offset from UTC. The offset is expressed as either UTC- or UTC+.

user_timezone_offset should have a value in seconds which can be between -54000 to 54000. For example, for IST (UTC+0530), "user_timezone_offset" will be 19800.

warning

Warning

Ensure that the platform value sent is Android, iOS, or web. Platform value depends on which platform the event was generated.
If you are unsure about the platform on which the event occurred, send the value as unknown or do not send any value. Incorrect platform value leads to inconsistencies in platform level campaigns like Push and In-App.

MoEngage does not accept any future dated events.

info

Note

MoEngage depends on current_time, user_time, and user_timezone_offset for generating the local time at which the event occurred. The local time is displayed in the user profile on the dashboard.

user_timezone_offset

Used to determine the current_time or user_time at which the event occurred. If the field is not present, either one of the following is used:

  • The timezone present in user profile is considered.
  • The event occurred in the UTC timezone.

The format contains a numeric value between -54000 to 54000. The value is the timezone offset of the local time from UTC in seconds.

current_time

Used to identify the UTC time at which the event occurred. You must pass the user_timezone_offset with current_time so that MoEngage can determine the timezone of the user and the local system time when the event occurred. 

If the field is not present, the system time at which the request was received is used as the current_time.

Allowed formats for current_time are:

  • ISO 8601, for example, 2020-05-31T16:33:35Z
  • Epoch time in seconds, for example - 1590404615

user_time

Used to identify the local system time at which the event occurred. You must pass the user_timezone_offset with user_time so that MoEngage can determine the timezone of the user and the UTC when the event occurred.

If the field is not present, the system time at which the request was received is used as the user_time.

Allowed formats for current_time are:

 

Example Payload

The following example provides tracking of numeric, boolean, and date type event attributes.
Use the payload described, where the price is numeric, departure_date is a date type attribute and premium_seat is a boolean attribute.

JSON
{
    "type": "event",
    "customer_id": "john@example.com",
    "actions": [{
		    "action": "Flight Booked",
		    "attributes": {
				"price": 3999,
				"departure_date": "2019-05-21T03:47:35Z",
				"premium_seat": true
			},
		    "platform": "iOS",
		    "app_version": "1.2.3",
		    "current_time": 1433837969,
		    "user_timezone_offset": 19800
		}
	]
}

 

Response Codes

200 400 401 403 413 415 429 500
Success Response
{ "status": "success", "message": "Your request has been accepted and will be processed soon." }

Sample cURL Request

cURL

curl --location --request POST 'https://api-01.moengage.com/v1/event/OAPQQ2AMD01MJZYZX1YPG?app_id=OAPQQ2AMD01MJZYZX1YPG' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic T0FQUVEyQU1EMDFNSMlRZWlgxWVBHOmxVcURvd2JqeGpleGdzR1ZVdlNA==' \
--data-raw '{
    "type": "event",
    "customer_id": "123",
    "actions" : [
          {
              "action": "ProductAdded",
              "attributes": {
                "product"  : "Accessories",
                "color"  : "Black",
                "Brand"  : "Adidas"
              },
              "platform" : "Android",
              "app_version" : "1.2.3",
              "user_time" : "1708939453396",
              "current_time" : "1708939453396"
          }
     ]
}'

 

Array Support

If you want to pass an attribute in an array, the appropriate syntax for that is:

cURL
"Array_attributeName":["abc","123"],

The sample cURL for adding and removing elements in an array is:

cURL

curl --location --request POST 'https://api-01.moengage.com/v1/event?app_id=VJ0GABESHMQA3L7WK3UR' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic VkoNNRVNITVFBM0w3V1YxRUVLM1VSOkZJd0N5dGZ0QWpZcl9tcVlldkVPVkFtbw==' \
--data-raw '{
    "type": "event",
    "customer_id": "John",
    "actions" : [
          {
              "action": "product_selected",
              "attributes": {
                "product"  : "Shirt",
                "color"  : "Green",
                "moe_os_type":"Xbox",
                "arraySupport":["abc","xyz"],
                "Brand"  : "Adidas"
              },
              "platform" : "TV",
             
              "app_version" : "1.2.3",
              "user_time" : "1710740192",
              "current_time" : "1710740192"
          }
     ]
}'


    

 

Postman Collections

We have made it easy for you to test the APIs. Click here to view it in Postman.

 

FAQs

  • How to identify the events to a given user? What identifiers can I use?
    Events in the payload need to be mapped to a given user who has executed the event. You must use the Customer ID to identify the events mapped to a customer. 

 

  • Can I send events for anonymous users?
    No, anonymous users can be tracked using MoEngage SDKs.

 

  • Can events be updated/modified?
    Events in MoEngage are immutable, i.e. events can only be created, they cannot be updated or deleted.

 

 

Previous

Next

Was this article helpful?
8 out of 22 found this helpful

How can we improve this article?