curl --request POST \
--url https://api-{dc}.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": "[email protected]"
}
'{
"message": "The business event has been triggered"
}Trigger Business Event
This API triggers a business event in MoEngage. You can set up campaigns to be executed when these events are triggered.
curl --request POST \
--url https://api-{dc}.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": "[email protected]"
}
'{
"message": "The business event has been triggered"
}Rate Limit
For Campaigns:- You can send a maximum of 10 triggers per 5 minutes.
- You can send a maximum of 50 triggers per hour.
- You can send a maximum of 200 triggers per day.
- You can trigger a maximum of 3 Business Trigger flows per hour.
- You can trigger a maximum of 10 Business Trigger flows per day.
承認
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.
ボディ
Event to trigger.
The name of the business event to be triggered.
"Series_Name"
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"
{
"season": "Season 1",
"episodes": 12,
"cast": ["John Doe", "Jane Doe"],
"date": "11/11/2023"
}
Information about who triggered the business event.
レスポンス
This response is returned when the request is processed successfully.
"The business event has been triggered"