Skip to main content
POST
/
alerts
/
send
curl --request POST \ --url https://api-0{dc}.moengage.com/v1.0/alerts/send \ --header 'Authorization: Basic <encoded-value>' \ --header 'Content-Type: application/json' \ --header 'MOE-APPKEY: <api-key>' \ --data ' { "alert_id": "636b77e6e2cf83277195fb60", "alert_reference_name": "Demo_ID", "user_id": "USER_12345", "transaction_id": "TXN_ABCDEF123", "payloads": { "SMS": { "recipient": "1234567890" } } } '
{
  "message": "Successfully Received",
  "request_id": "<string>",
  "SMS": {
    "message": "<string>",
    "err_code": "<string>",
    "status_code": 123
  },
  "EMAIL": {
    "message": "<string>",
    "err_code": "<string>",
    "status_code": 123
  },
  "PUSH": {
    "message": "<string>",
    "err_code": "<string>",
    "status_code": 123
  }
}

​
Rate Limit

The default rate limit is 10K RPM.

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). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
  • Password: Use your API Key, which you can find within the Inform tile.

Note: After you generate and save the Inform API Key (SECRET KEY), DO NOT generate a new key unless there is a security breach. After you generate a different key and save it, API calls using the older key won't work.

For more information on authentication and getting your credentials, refer here.

​
MOE-APPKEY
string
header
required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

Body

application/json

The payload containing the alert identifier, transaction details, and recipient information for each channel.

​
transaction_id
string
required

This is the unique identifier denoting the transaction for which the Alert is being sent to the user. This information is maintained by the brand and is passed in the request. The maximum length allowed for this field is 50 characters.

​
payloads
object
required

The payload contains the following channel-level information for all the configured channels.

​
alert_id
string

This field uniquely identifies the Alert to be sent to the user. For the staging endpoint, use the test alert id and for the live endpoint, use the alert id. For more information, refer to Live and Test Alerts.

​
alert_reference_name
string

This field is used to identify the Alert using your reference Name and can be used to identify the alert as an alternative to Alert ID.

​
user_id
string

This is the unique user identifier information you maintain. This information should be passed in the request to facilitate the mapping of the channel events back to the user profile to which this user_id is associated in MoEngage.

Response

Request has been received and processed. The response body contains the status for the overall request and for each individual channel.

​
message
string
Example:

"Successfully Received"

​
request_id
string
​
SMS
object
​
EMAIL
object
​
PUSH
object