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: <content-type>' \
  --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.

​
FAQs

No, it is not required to pass all the attributes while triggering the business event.
You can view the campaign analytics to see if the campaign for the business event has been triggered successfully. Navigate to Engage -> Campaigns on the MoEngage Dashboard and search for the campaign associated with the Business Event.

Authorizations

​
Authorization
string
header
required

The Basic authentication header contains your Base64-encoded key. This authentication parameter, used for access control, must be passed with the request.

Format: Authorization: Basic Base64_ENCODED_WORKSPACEID_APIKEY==

Headers

​
Content-Type
string
default:application/json
required

Set the Content-Type header to application/json.

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"