Overview
The MoEngage Business Events API allows you to create and trigger specialized events that represent business occurrences—such as a flight delay, a price drop on a watched item, or the release of a new OTT series episode. These events act as triggers for Business Event Triggered Campaigns, allowing you to automate high-context communication based on external data points rather than just user behavior.The Business Events API requires authentication via your MoEngage Workspace ID and API Key. Ensure these are included in your Basic Auth header.
Business Events API Endpoints
The Business Events API consists of the following core capabilities:- Create Business Event - Define the schema and attributes for a new event.
- Trigger Business Event - Fire an event to initiate associated campaigns.
- Search Business Events - Retrieve details of existing events using IDs or names.
Supported Attribute Data Types
When creating a Business Event, you must define theattribute_data_type. The following types are supported:
| Data Type | Description |
|---|---|
| String | Textual data (e.g., “Season 1”, “Flight-101”) |
| Integer | Whole numbers (e.g., episode count) |
| Float | Decimal numbers (e.g., price, ratings) |
| Date | Calendar dates |
| Array | A list of values (e.g., a list of cast members) |
Usage Guidelines & Limits
NotesWorkspace Limits:
- You can create a maximum of 50 unique business events per workspace.
- Business event names must be unique; you cannot create two events with the same name.
- Triggers: You can send 200 triggers per day, with a maximum of 50 triggers per hour.
- Search: The search API is limited to 100 Requests Per Minute (RPM).
FAQs
Managing Business Events
What data types are supported for event attributes?
What data types are supported for event attributes?
The supported data types include integer, float, string, date, and array.
Can I create two business events with the same name?
Can I create two business events with the same name?
No, business event names must be unique within your workspace.
How do I view all events I have created?
How do I view all events I have created?
You can use the Search Business Events API to fetch a list of all events associated with your workspace.
Triggering Campaigns
Do I need to pass all attributes during a trigger?
Do I need to pass all attributes during a trigger?
No, it is not mandatory to pass all defined attributes when triggering the event. Only include the attributes required for your campaign personalization.
How do I verify if a campaign was successfully triggered?
How do I verify if a campaign was successfully triggered?
Navigate to Engage -> Campaigns on the MoEngage Dashboard and search for the campaign associated with your Business Event to view real-time analytics and trigger counts.
What happens if I trigger an event with no active campaign?
What happens if I trigger an event with no active campaign?
The API will return a
400 Bad Request error with the message “No active campaign found for business event name.” Ensure your campaign is in the Active state before triggering.