Skip to main content
POST

Rate Limits

The rate limits are at the workspace level. A maximum of 30 requests per minute and 500 requests per hour are allowed per workspace.

Example Requests

Search by Names
Search by IDs
List Everything

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

Filter and pagination for the search. Provide either names or ids inside filters (not both); omit filters to return everything (paginated).

filters
object

Filter criteria. Provide either names or ids, not both.

limit
integer
default:20

Page size. Max 20 per page.

Required range: x <= 20
cursor
string

Opaque pagination cursor from a previous response.

Response

Business event list

response_id
string

Unique identifier for this response. Echoes the X-MOE-Request-Id header you sent, returned unchanged. When you omit it, MoEngage generates a 12-character hexadecimal identifier. Quote it when contacting MoEngage Support.

Example:

"5f3e2a1b9c8d"

type
enum<string>

The resource type contained in data. Always business-events for this endpoint.

Available options:
business-events
data
object[]

The business events matching your filters, up to limit per page.

pagination
object

Cursor pagination state for this page of results.