Endpoints
The Business Events API is a collection of the following endpoints:- Create Business Event: Define the schema and attributes for a new event.
- Trigger Business Event: Trigger an event to initiate associated campaigns.
- Search Business Events: Retrieve details of existing events using IDs or names.
FAQs
Manage 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.
Trigger 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.