Available Events API

Retrieve the list of event types that can be used as trigger events. Always fetch this list to get the correct identifiers — do not hardcode them.

Event type object

Field	Type	Description
identifier	String	Event identifier — use this as the event value on a trigger
label	String	Human-readable event name
configurable_params	Object[]	Event-specific parameters (may be empty)

Each object in configurable_params has:

Field	Type	Description
name	String	Parameter key — use as the key in event_params on the trigger
label	String	Human-readable parameter name
type	String	Data type: int, time, or string
default	Mixed	Default value
notice	String	Usage description

List available events

GET /rest/V1/mst-email/available-events

Optional query parameter filters results by identifier or label substring (case-insensitive):

GET /rest/V1/mst-email/available-events?query=order_status

Response:

[
  {
    "identifier": "order_new",
    "label": "Sales / New order was created",
    "configurable_params": [
      {
        "name": "expire_after",
        "label": "Deduplication window",
        "type": "time",
        "default": 60,
        "notice": "Minimum time before the same event fires again for the same recipient."
      }
    ]
  },
  {
    "identifier": "customer_no_activity",
    "label": "Customer / No Activity",
    "configurable_params": [
      {
        "name": "inactivity_days",
        "label": "Inactivity (days)",
        "type": "int",
        "default": 30,
        "notice": "Trigger fires for customers with no activity for exactly this many days."
      },
      {
        "name": "expire_after",
        "label": "Deduplication window",
        "type": "time",
        "default": 86400,
        "notice": "Minimum time before the same event fires again for the same recipient."
      }
    ]
  }
]

Notes

order_status|* events are returned as individual entries per status — one for each Magento order status (e.g. order_status|pending, order_status|complete). Use ?query=order_status to list them all.

Cron-based events require Magento cron to be running. These events fire on a schedule rather than in response to a storefront action:

Identifier	Description
customer_birthday	Fires on the customer's birthday
customer_create	Fires after a new customer account is created
customer_no_activity	Fires when a customer has been inactive for N days
quote_abandoned	Fires when a cart has been abandoned for N minutes
review_new	Fires after a product review is submitted
wishlist_product_back_in_stock	Fires when a wishlisted product is back in stock
wishlist_product_low_stock	Fires when a wishlisted product is running low on stock
wishlist_product_discounted	Fires when a wishlisted product is discounted

Configurable params are passed as a JSON string in the event_params field on the trigger. For example, to set a 90-minute abandonment window for quote_abandoned:

{
  "event_params": "{\"abandoned_after_minutes\": 90}"
}