Skip to main content
POST
Trigger Business Event (V5)

Rate Limits

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.
For flows:
  • You can trigger a maximum of 3 business trigger flows per hour.
  • You can trigger a maximum of 10 business trigger flows per day.
If you need higher limits, reach out to your Customer Success Manager (CSM) or MoEngage Support team.

Example Request

Trigger a Business Event

Authorizations

Authorization
string
header
required

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). Find it in the MoEngage dashboard at Settings > Account > API keys.
  • Password: Use an API key from Settings > Account > API keys.

Refer to API Key Dashboard for details on creating and managing API keys.

Headers

X-MOE-Request-Id
string<uuid>

Client-supplied trace ID (UUID v4). Echoed back in the X-MOE-Request-Id response header and returned unchanged as response_id in the body. When you omit this header, MoEngage generates a 12-character hexadecimal identifier instead. Quote it when contacting MoEngage Support.

On Trigger Business Event (V5), the body field moe_request_id takes precedence: when you send both, response_id echoes moe_request_id, and this header is returned only in the X-MOE-Request-Id response header.

Body

application/json

Event to trigger.

Attribute values are validated against the registered attribute schema (types, presence). Unknown attributes are rejected with a 400.

event_name
string
required

Name of a business event registered in this workspace.

Example:

"price_drop"

triggered_by
string<email>
required

Email of the user/service firing the event. Required.

event_attributes
object

Attribute values for this firing, keyed by attribute name. Types must match the registered schema (string, number, boolean, datetime).

Example:
moe_request_id
string<uuid>

Optional request id, returned unchanged as response_id and used for tracing. This field takes precedence over the X-MOE-Request-Id header — when you send both, response_id echoes this value, and the header value is returned only in the X-MOE-Request-Id response header.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

This response is returned when the trigger request is processed successfully, whether the result is full success, partial success, or complete failure to reserve the attached campaigns/flows.

response_id
string

Echo of the caller-supplied moe_request_id, returned unchanged. When you omit moe_request_id, it echoes the X-MOE-Request-Id header instead; when you send neither, MoEngage generates a 12-character hexadecimal identifier.

Example:

"5f3e2a1b9c8d"

type
enum<string>
Available options:
business-event
Example:

"business-event"

data
object