Skip to main content
POST
/
business_event
Create Business Event
curl --request POST \
  --url https://api-0{X}.moengage.com/v1.0/business_event \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_name": "NameOfOTTSeries",
  "event_attributes": [
    {
      "attribute_name": "season",
      "attribute_data_type": "string"
    },
    {
      "attribute_name": "episodes",
      "attribute_data_type": "int"
    },
    {
      "attribute_name": "cast",
      "attribute_data_type": "array"
    },
    {
      "attribute_name": "released_on",
      "attribute_data_type": "date"
    },
    {
      "attribute_name": "budget",
      "attribute_data_type": "float"
    }
  ],
  "created_by": "john.doe@example.com"
}
'
{
  "message": "The business event has been created",
  "event_id": "64a40cff5547a6b2c5b14404"
}

​
Rate Limit

The rate limits are at the workspace level. You can create a maximum of 50 business events for each workspace.

Authorizations

​
Authorization
string
header
required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

  • Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
  • Password: Use your API Key, which you can find within the Campaign report/Business events/Custom templates/Catalog API/Inform Report tile.

For more information on authentication and getting your credentials, refer here.

Body

application/json

Business event definition.

​
event_name
string
required

This field contains the name of the business event.

Example:

"NameOfOTTSeries"

​
event_attributes
object[]
required

This field contains the event attributes of the business event being created.

​
created_by
string<email>
required

The email address of the creator of the business event.

Example:

"john.doe@example.com"

Response

This response is returned when the request is processed successfully.

​
message
string
Example:

"The business event has been created"

​
event_id
string

Unique identifier for the created business event.

Example:

"64a40cff5547a6b2c5b14404"