Events API
The event log records all Magento events that have been captured for processing by Follow Up Email triggers. All endpoints require authentication.
Event object
| Field | Type | Description |
|---|---|---|
event_id | Int | Unique identifier (read-only) |
identifier | String | Event type identifier (e.g. order_new, quote_abandoned) |
key | String | Unique key for deduplication (e.g. order_id:42) |
params_serialized | String | JSON-encoded event context data |
store_id | Int | Store view where the event occurred |
created_at | String | When the event was captured (read-only) |
expire_at | String | When the event expires and will be removed |
configurable_params | Object[] | Parameter definitions for this event type (same structure as in Available Events) |
List events
GET /rest/V1/mst-email/events
Filter by identifier to see all events of a specific type:
GET /rest/V1/mst-email/events
?searchCriteria[filter_groups][0][filters][0][field]=identifier
&searchCriteria[filter_groups][0][filters][0][value]=quote_abandoned
&searchCriteria[filter_groups][0][filters][0][condition_type]=eq
&searchCriteria[sort_orders][0][field]=created_at
&searchCriteria[sort_orders][0][direction]=DESC
Supports filtering and pagination.
Get event
GET /rest/V1/mst-email/events/:id
Response:
{
"event_id": 8741,
"identifier": "quote_abandoned",
"key": "quote_id:217",
"params_serialized": "{\"quote_id\":217,\"customer_email\":\"[email protected]\",\"store_id\":1}",
"store_id": 1,
"created_at": "2026-06-10 14:22:00",
"expire_at": "2026-06-17 14:22:00"
}
Errors: 404 event not found.
Fetch new events
Manually triggers the event fetch process — processes any pending events and creates queue items. Useful for testing or forcing immediate processing outside of the normal cron cycle.
POST /rest/V1/mst-email/events/fetch
No request body required.
Response:
true
Reset event
Resets an event so it will be re-processed by triggers on the next cron run.
POST /rest/V1/mst-email/events/:id/reset
No request body required.
Response:
true
Errors: 404 event not found.
Validate event
Checks each trigger against this event and returns one diagnostic message per trigger explaining why it would or would not fire.
POST /rest/V1/mst-email/events/:id/validate
No request body required.
Response:
[
"skip: trigger does not follow event customer_login",
"skip: trigger is inactive",
"ok: trigger matches"
]
Errors: 404 event not found.
Delete event
DELETE /rest/V1/mst-email/events/:id
Response:
true
Errors: 404 event not found.