Skip to main content
POST
/
business_event
/
trigger
Trigger Business Event
curl --request POST \
  --url https://api-0{X}.moengage.com/v1.0/business_event/trigger \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_name": "Series_Name",
  "event_attributes": {
    "season": "Season 1",
    "episodes": 12,
    "cast": [
      "John Doe",
      "Jane Doe"
    ],
    "date": "11/11/2023"
  },
  "triggered_by": "john.doe@example.com"
}
'
{
  "message": "The business event has been triggered"
}

​
Rate Limit

You can send 200 triggers in a day, and 50 in each hour.

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

Event to trigger.

​
event_name
string
required

The name of the business event to be triggered.

Example:

"Series_Name"

​
event_attributes
object
required

This field contains the event attributes with which the business event will be triggered.

Structure: "event_attributes": { "attribute_name1": "", ... }

Every attribute contains the following information: attribute_name - This field contains the name of the business event attribute for which the value is being sent in the request. The attribute_name is a String.

Example: "attribute_name": "season"

Example:
{
  "season": "Season 1",
  "episodes": 12,
  "cast": ["John Doe", "Jane Doe"],
  "date": "11/11/2023"
}
​
triggered_by
string<email>

Information about who triggered 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 triggered"