Overview
Inform facilitates a unified messaging infrastructure across multiple channels with a single API for building and managing transactional alerts.
Transactional Alerts can be sent in the following scenarios:
- Order/Booking/Purchase confirmations
- Shipping/Delivery confirmations and updates
- Security and account alerts
- Password resets
- OTP (one-time password)
- User invitations and shares
- User inaction related to previous transactions
- Fraud prevention/security alerts
The Inform API sends notifications to all the channels simultaneously for a specified Live Alert. You can use the Inform API to do the following:
- Send a transactional message on a single channel like SMS or Email or Push
- Send transactional messages on multiple channels
Glossary
We’ve put together a list of terminology that you will encounter when using the Inform Service API.
Alert ID
This is the unique identifier for an Alert. This field will be used to identify the Alert configured in the MoEngage Dashboard that contains the template for the notifications to be sent to the user.
Alert Reference Name
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.
Test Alert ID
When creating an Alert, you can test it on an external console and MoEngage provides a unique identifier called Test Alert ID for this purpose.
Test Alert Reference Name
Test Alert Reference Name is configured while adding the alert on the Dashboard to send this Test Alert request to an external console.
Live and Test Alerts (Add a row for Reference name)
| Live Alerts | Test Alerts |
|---|---|
|
The unique Identifier for a published Alert is called the Alert ID. |
The unique identifier for a test Alert is called the Test Alert ID. |
|
The Alert Logs are available in the Alert Info Section. |
The Test Alert Logs are available in the third step of Alert creation. |
API Endpoint
For Live Alerts
https://api-01.moengage.com/v1.0/alerts/send
For Test Alerts
https://sandbox-api-0X.moengage.com/v1.0/alerts/send
The 'X' in the API Endpoint URL refers to the MoEngage Data Center (DC). MoEngage maintains different data centres for different clients. You can find your DC number (value of X) and replace the value of 'X' in the URL by referring to the DC and API endpoint mapping here.
Authentication
The API request will be authenticated through Basic Authentication. Basic Authentication sends a Base64-encoded string containing your username and password with every API request. It encodes a 'username:password' string in Base64 and appends the encoded string with 'Basic '. This string is included in the authorization header as shown below:
{"Authorization":"Basic Base64_ENCODED_WORKSPACEID_APIKEY="}
You can obtain the username and password details from the MoEngage Dashboard.
- Navigate to Settings -> Account -> APIs.
- Copy the following details:
- Username: Under Workspace ID (earlier app id), click the copy icon to copy the username.
- Password: In the API keys section, click the copy icon in the Inform tile to copy the API key.
- Use these details to authenticate the API requests.
Regenerate API SECRET
The API SECRET can be regenerated on the MoEngage Dashboard in the INFORM API Settings section discussed above.
Please DO NOT regenerate the key unless there is a security breach. Once you generate a different API SECRET KEY and save it, API calls using the older SECRET KEY won't work.
Request Headers
| Key | Sample Values | Description |
|---|---|---|
|
MOE-APPKEY |
{"MOE-APPKEY": "APP ID"} |
This is the Workspace ID (or App ID) of your MoEngage account and needs to be passed along with the request. You can find your MoEngage APP ID in the MoEngage Dashboard API Settings. For more information, refer to Authentication. |
|
Authorization |
{"Authorization": "Basic Base64_ENCODED_WORKSPACEID_APIKEY=="} |
This authentication parameter, used for access control, must be passed along with the request. To generate the authentication header, refer to Authentication. |
|
Content-Type |
application/JSON |
Set the Content-Type header to application/JSON for using the Inform API. |
Request Body
| Key | Type | Value | Description |
|---|---|---|---|
|
alert_id |
Mandatory |
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 |
Mandatory |
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 |
Optional |
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. MoEngage stores this unique identifier as the Client ID in the user profile. |
|
transaction_id |
Mandatory |
String |
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. The Inform API supports idempotency using this parameter. If a request contains a transaction_id and is successful and another request with the same transaction ID is received within 5 minutes of the successful request, the new request would be deemed a duplicate one. |
|
payloads |
Mandatory |
JSON Object |
[payloadobject, payloadobject..] Payload object - <medium>: { “recipient”:<recipient value>, “peronsalized_attributes”:<json object of personalized key-value parameters> } ] The payload contains the following channel-level information for all the configured channels:
Note:
|
Sample Requests for a Live Alert Without Personalization
Case 1: One channel is configured for the Alert
Only SMS Channel
curl --location --request POST 'https://inform-api-0X.moengage.com/v1/send' \
--header 'MOE-APPKEY: YOUR_APP_KEY_HERE' \
--header 'Authorization: Basic Base64_ENCODED_APPKEY_APIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"SMS": {
"recipient": "123456789"
}
}
}' import fetch from 'node-fetch';
fetch('https://inform-api-0X.moengage.com/v1/send', {
method: 'POST',
headers: {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type': 'application/json'
},
//body: "{\n \"alert_id\": \"636b77e6e2cf83277195fb60\",\n \"alert_reference_name\": \"Demo_ID\",\n \"user_id\": \"USER_ID\",\n \"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",\n \"payloads\": {\n \"SMS\": {\n \"recipient\": \"123456789\"\n }\n }\n}",
body: JSON.stringify({
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"SMS": {
"recipient": "123456789"
}
}
})
}); package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"SMS": {
"recipient": "123456789"
}
}
}`)
req, err := http.NewRequest("POST", "https://inform-api-0X.moengage.com/v1/send", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("MOE-APPKEY", "YOUR_APP_KEY_HERE")
req.Header.Set("Authorization", "Basic Base64_ENCODED_APPKEY_APIKEY")
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s
", bodyText)
}<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://inform-api-0X.moengage.com/v1/send');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'MOE-APPKEY' =-> 'YOUR_APP_KEY_HERE',
'Authorization' => 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type' => 'application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"alert_id":"636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID","user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"SMS":{"recipient":"123456789"}}}');
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$response = curl_exec($ch);
curl_close($ch);import requests
headers = {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
# Already added when you pass json= but not when you pass data=
# 'Content-Type': 'application/json',
}
json_data = {
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"SMS": {
"recipient": "123456789"
}
}
}
response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, json=json_data)
# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{"alert_id": "636b77e6e2cf83277195fb60", "alert_reference_name":"Demo_ID","user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"SMS":{"recipient":"123456789"}}}'
#response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, data=data)
require 'net/http'
require 'json'
uri = URI('https://inform-api-0X.moengage.com/v1/send')
req = Net::HTTP::Post.new(uri)
req.content_type = 'application/json'
req['MOE-APPKEY'] = 'YOUR_APP_KEY_HERE'
req['Authorization'] = 'Basic Base64_ENCODED_APPKEY_APIKEY'
# The object won't be serialized exactly like this
# req.body = "{"alert_id":"636b77e6e2cf83277195fb60","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"SMS":{"recipient":"123456789"}}}"
req.body = {
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"SMS": {
"recipient": "123456789"
}
}
}.to_json
req_options = {
use_ssl: uri.scheme == "https"
}
res = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(req)
end
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
public class Main {
public static void main(String[] args) throws IOException {
URL url = new URL("https://inform-api-0X.moengage.com/v1/send");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod(“POST”);
httpConn.setRequestProperty(“MOE-APPKEY”, “YOUR_APP_KEY_HERE”);
httpConn.setRequestProperty(“Authorization”, “Basic Base64_ENCODED_APPKEY_APIKEY”);
httpConn.setRequestProperty(“Content-Type”, “application/json”);
httpConn.setDoOutput(true);
String payload = "{
\"alert_id\": \"636bc615e2cf83285495055f\",
\"alert_reference_name\": \"Demo_ID\",
\"user_id\": \"USER_ID\",
\"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",
\"payloads\": {
\"SMS\": {
\"recipient\": \"123456789\"
}
}
}";
httpConn.setDoOutput(true);
OutputStream os = httpConn.getOutputStream();
os.write(payload.getBytes());
os.flush();
InputStream responseStream = httpConn.getResponseCode() == HttpURLConnection.HTTP_OK
? httpConn.getInputStream()
: httpConn.getErrorStream();
BufferedReader br = new BufferedReader(new InputStreamReader(
(responseStream)));
String output;
while ((output = br.readLine()) != null) {
System.out.println(output);
}
httpConn.disconnect();
}
}
Only Email Channel
curl --location --request POST 'https://inform-api-0X.moengage.com/v1/send' \
--header 'MOE-APPKEY: YOUR_APP_KEY_HERE' \
--header 'Authorization: Basic Base64_ENCODED_APPKEY_APIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"EMAIL": {
"recipient": "john.doe@moengage.com"
}
}
}'import fetch from 'node-fetch';
fetch('https://inform-api-0X.moengage.com/v1/send', {
method: 'POST',
headers: {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type': 'application/json'
},
// body: "{\n \"alert_id\": \"636b77e6e2cf83277195fb60\",\n \"user_id\": \"USER_ID\",\n \"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",\n \"payloads\": {\n \"EMAIL\": {\n \"recipient\": \"john.doe@moengage.com\"\n }\n }\n}",
body: JSON.stringify({
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": { "EMAIL": { "recipient": "john.doe@moengage.com" } } }) });package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"EMAIL": {
"recipient": "john.doe@moengage.com"
}
}
}`)
req, err := http.NewRequest("POST", "https://inform-api-0X.moengage.com/v1/send", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("MOE-APPKEY", "YOUR_APP_KEY_HERE")
req.Header.Set("Authorization", "Basic Base64_ENCODED_APPKEY_APIKEY")
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s
", bodyText)
}<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://inform-api-0X.moengage.com/v1/send');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'MOE-APPKEY' => 'YOUR_APP_KEY_HERE',
'Authorization' => 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type' => 'application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"alert_id":"636b77e6e2cf83277195fb60","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"EMAIL":{"recipient":"john.doe@moengage.com"}}}');
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$response = curl_exec($ch);
curl_close($ch);import requests
headers = {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
# Already added when you pass json= but not when you pass data=
# 'Content-Type': 'application/json',
}
json_data = {
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"EMAIL": {
"recipient": "john.doe@moengage.com"
}
}
}
response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, json=json_data)
# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{"alert_id":"636b77e6e2cf83277195fb60","user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"EMAIL":{"recipient":"john.doe@moengage.com"}}}'
#response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, data=data)require 'net/http'
require 'json'
uri = URI('https://inform-api-0X.moengage.com/v1/send')
req = Net::HTTP::Post.new(uri)
req.content_type = 'application/json'
req['MOE-APPKEY'] = 'YOUR_APP_KEY_HERE'
req['Authorization'] = 'Basic Base64_ENCODED_APPKEY_APIKEY'
# The object won't be serialized exactly like this
# req.body = "{"alert_id":"636b77e6e2cf83277195fb60","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"EMAIL":{"recipient":"john.doe@moengage.com"}}}"
req.body = {
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"EMAIL": {
"recipient": "john.doe@moengage.com"
}
}
}.to_json
req_options = {
use_ssl: uri.scheme == "https"
}
res = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(req)
endimport java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
public class Main {
public static void main(String[] args) throws IOException {
URL url = new URL("https://i-inform-api-00.moengage.com/v1/send");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod(“POST”);
httpConn.setRequestProperty(“MOE-APPKEY”, “YOUR_APP_KEY_HERE”);
httpConn.setRequestProperty(“Authorization”, “Basic Base64_ENCODED_APPKEY_APIKEY”);
httpConn.setRequestProperty(“Content-Type”, “application/json”);
httpConn.setDoOutput(true);
String payload = "{
\"alert_id\": \"636bc615e2cf83285495055f\",
\"alert_reference_name\": \"Demo_ID\",
\"user_id\": \"USER_ID\",
\"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",
\"payloads\": {
\"EMAIL\": {
\"recipient\": \"john.doe@moengage.com\"
}
}
}";
httpConn.setDoOutput(true);
OutputStream os = httpConn.getOutputStream();
os.write(payload.getBytes());
os.flush();
InputStream responseStream = httpConn.getResponseCode() == HttpURLConnection.HTTP_OK
? httpConn.getInputStream()
: httpConn.getErrorStream();
BufferedReader br = new BufferedReader(new InputStreamReader(
(responseStream)));
String output;
while ((output = br.readLine()) != null) {
System.out.println(output);
}
httpConn.disconnect();
}
}Only Push Channel
curl --location --request POST 'https://inform-api-0X.moengage.com/v1/send' \
--header 'MOE-APPKEY: YOUR_APP_KEY_HERE' \
--header 'Authorization: Basic Base64_ENCODED_APPKEY_APIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>"
}
}
}'
import fetch from 'node-fetch';
fetch('https://inform-api-0X.moengage.com/v1/send', {
method: 'POST',
headers: {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type': 'application/json'
},
//body: "{\n \"alert_id\": \"636b77e6e2cf83277195fb60\",\n \"alert_reference_name\": \"Demo_ID\",\n \"user_id\": \"USER_ID\",\n \"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",\n \"payloads\": {\n \"PUSH\": {\n \"recipient\": \"<push-token>\"\n }\n }\n}",
body: JSON.stringify({
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>"
}
}
})
}); package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>"
}
}
}`)
req, err := http.NewRequest("POST", "https://inform-api-0X.moengage.com/v1/send", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("MOE-APPKEY", "YOUR_APP_KEY_HERE")
req.Header.Set("Authorization", "Basic Base64_ENCODED_APPKEY_APIKEY")
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s
", bodyText)
}<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://inform-api-0X.moengage.com/v1/send');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'MOE-APPKEY' =-> 'YOUR_APP_KEY_HERE',
'Authorization' => 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type' => 'application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"alert_id":"636b77e6e2cf83277195fb60","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>"}}}');
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$response = curl_exec($ch);
curl_close($ch);import requests
headers = {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
# Already added when you pass json= but not when you pass data=
# 'Content-Type': 'application/json',
}
json_data = {
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>"
}
}
}
response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, json=json_data)
# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{"alert_id":"636b77e6e2cf83277195fb60","user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>"}}}'
#response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, data=data)
require 'net/http'
require 'json'
uri = URI('https://inform-api-0X.moengage.com/v1/send')
req = Net::HTTP::Post.new(uri)
req.content_type = 'application/json'
req['MOE-APPKEY'] = 'YOUR_APP_KEY_HERE'
req['Authorization'] = 'Basic Base64_ENCODED_APPKEY_APIKEY'
# The object won't be serialized exactly like this
# req.body = "{"alert_id":"636b77e6e2cf83277195fb60","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>"}}}"
req.body = {
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>"
}
}
}.to_json
req_options = {
use_ssl: uri.scheme == "https"
}
res = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(req)
end
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
public class Main {
public static void main(String[] args) throws IOException {
URL url = new URL("https://inform-api-0X.moengage.com/v1/send");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod(“POST”);
httpConn.setRequestProperty(“MOE-APPKEY”, “YOUR_APP_KEY_HERE”);
httpConn.setRequestProperty(“Authorization”, “Basic Base64_ENCODED_APPKEY_APIKEY”);
httpConn.setRequestProperty(“Content-Type”, “application/json”);
httpConn.setDoOutput(true);
String payload = "{
\"alert_id\": \"636bc615e2cf83285495055f\",
\"alert_reference_name\": \"Demo_ID\",
\"user_id\": \"USER_ID\",
\"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",
\"payloads\": {
\"PUSH\": {
\"recipient\": \"<push-token>\"
}
}
}";
httpConn.setDoOutput(true);
OutputStream os = httpConn.getOutputStream();
os.write(payload.getBytes());
os.flush();
InputStream responseStream = httpConn.getResponseCode() == HttpURLConnection.HTTP_OK
? httpConn.getInputStream()
: httpConn.getErrorStream();
BufferedReader br = new BufferedReader(new InputStreamReader(
(responseStream)));
String output;
while ((output = br.readLine()) != null) {
System.out.println(output);
}
httpConn.disconnect();
}
}Case 2: Multiple channels are configured for the Alert
curl --location --request POST 'https://inform-api-0X.moengage.com/v1/send' \
--header 'MOE-APPKEY: YOUR_APP_KEY_HERE' \
--header 'Authorization: Basic Base64_ENCODED_APPKEY_APIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>"
},
"EMAIL": {
"recipient": "john.doe@moengage.com"
}
}
}'import fetch from 'node-fetch';
fetch('https://inform-api-0X.moengage.com/v1/send', {
method: 'POST',
headers: {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type': 'application/json'
},
// body: "{\n \"alert_id\": \"636b77e6e2cf83277195fb60\",\n \"alert_reference_name\": \"Demo_ID\",\n \"user_id\": \"USER_ID\",\n \"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",\n \"payloads\": {\n \"PUSH\": {\n \"recipient\": \"<push-token>\"\n },\n \"EMAIL\": {\n \"recipient\": \"john.doe@moengage.com\"\n }\n }\n}",
body: JSON.stringify({
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>"
},
"EMAIL": {
"recipient": "john.doe@moengage.com"
}
}
})
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>"
},
"EMAIL": {
"recipient": "john.doe@moengage.com"
}
}
}`)
req, err := http.NewRequest("POST", "https://inform-api-0X.moengage.com/v1/send", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("MOE-APPKEY", "YOUR_APP_KEY_HERE")
req.Header.Set("Authorization", "Basic Base64_ENCODED_APPKEY_APIKEY")
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s
", bodyText)
}
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://inform-api-0X.moengage.com/v1/send');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'MOE-APPKEY' => 'YOUR_APP_KEY_HERE',
'Authorization' => 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type' => 'application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"alert_id":"636b77e6e2cf83277195fb60","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>"},"EMAIL":{"recipient":"john.doe@moengage.com"}}}');
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$response = curl_exec($ch);
curl_close($ch);import requests
headers = {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
# Already added when you pass json= but not when you pass data=
# 'Content-Type': 'application/json',
}
json_data = {
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>"
},
"EMAIL": {
"recipient": "john.doe@moengage.com"
}
}
}
response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, json=json_data)
# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{"alert_id":"636b77e6e2cf83277195fb60","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>"},"EMAIL":{"recipient":"john.doe@moengage.com"}}}'
#response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, data=data)require 'net/http'
require 'json'
uri = URI('https://inform-api-0X.moengage.com/v1/send')
req = Net::HTTP::Post.new(uri)
req.content_type = 'application/json'
req['MOE-APPKEY'] = 'YOUR_APP_KEY_HERE'
req['Authorization'] = 'Basic Base64_ENCODED_APPKEY_APIKEY'
# The object won't be serialized exactly like this
# req.body = "{"alert_id":"636b77e6e2cf83277195fb60","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>"},"EMAIL":{"recipient":"john.doe@moengage.com"}}}"
req.body = {
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>"
},
"EMAIL": {
"recipient": "john.doe@moengage.com"
}
}
}.to_json
req_options = {
use_ssl: uri.scheme == "https"
}
res = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(req)
endimport java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
public class Main {
public static void main(String[] args) throws IOException {
URL url = new URL("https://inform-api-0X.moengage.com/v1/send");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod(“POST”);
httpConn.setRequestProperty(“MOE-APPKEY”, “YOUR_APP_KEY_HERE”);
httpConn.setRequestProperty(“Authorization”, “Basic Base64_ENCODED_APPKEY_APIKEY”);
httpConn.setRequestProperty(“Content-Type”, “application/json”);
httpConn.setDoOutput(true);
String payload = "{
\"alert_id\": \"636bc615e2cf83285495055f\",
\"alert_reference_name\": \"Demo_ID\",
\"user_id\": \"USER_ID\",
\"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",
\"payloads\": {
\"PUSH\": {
\"recipient\": \"<push-token>\"
},
\"EMAIL\": {
\"recipient\": \"john.doe@moengage.com\"
}
}
}";
httpConn.setDoOutput(true);
OutputStream os = httpConn.getOutputStream();
os.write(payload.getBytes());
os.flush();
InputStream responseStream = httpConn.getResponseCode() == HttpURLConnection.HTTP_OK
? httpConn.getInputStream()
: httpConn.getErrorStream();
BufferedReader br = new BufferedReader(new InputStreamReader(
(responseStream)));
String output;
while ((output = br.readLine()) != null) {
System.out.println(output);
}
httpConn.disconnect();
}
}Sample Request for a Live Alert with Personalization
Case 1: One channel is configured for the Alert
Only SMS Channel
curl --location --request POST 'https://inform-api-0X.moengage.com/v1/send' \
--header 'MOE-APPKEY: YOUR_APP_KEY_HERE' \
--header 'Authorization: Basic Base64_ENCODED_APPKEY_APIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"SMS": {
"recipient": "123456789",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}'import fetch from 'node-fetch';
fetch('https://inform-api-0X.moengage.com/v1/send', {
method: 'POST',
headers: {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type': 'application/json'
},
// body: "{\n \"alert_id\": \"636b9d5de2cf8328549503b9\",\n \"alert_reference_name\": \"Demo_ID\",\n \"user_id\": \"USER_ID\",\n \"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",\n \"payloads\": {\n \"SMS\": {\n \"recipient\": \"123456789\",\n \"personalized_attributes\": {\n \"firstname\": \"YOUR_firstname_ATTRIBUTE_VAL_HERE\",\n \"orderid\": \"YOUR_orderid_ATTRIBUTE_VAL_HERE\",\n \"deliverydate\": \"YOUR_deliverydate_ATTRIBUTE_VAL_HERE\",\n \"deliveryslot_starttime\": \"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE\",\n \"deliveryslot_endtime\": \"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE\"\n }\n }\n }\n}",
body: JSON.stringify({
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"SMS": {
"recipient": "123456789",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
})
});package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"SMS": {
"recipient": "123456789",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}`)
req, err := http.NewRequest("POST", "https://inform-api-0X.moengage.com/v1/send", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("MOE-APPKEY", "YOUR_APP_KEY_HERE")
req.Header.Set("Authorization", "Basic Base64_ENCODED_APPKEY_APIKEY")
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s
", bodyText)
}<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://inform-api-0X.moengage.com/v1/send');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'MOE-APPKEY' => 'YOUR_APP_KEY_HERE',
'Authorization' => 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type' => 'application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"alert_id":"636b9d5de2cf8328549503b9","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"SMS":{"recipient":"123456789","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}}}}');
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$response = curl_exec($ch);
curl_close($ch);import requests
headers = {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
# Already added when you pass json= but not when you pass data=
# 'Content-Type': 'application/json',
}
json_data = {
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"SMS": {
"recipient": "123456789",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}
response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, json=json_data)
# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{"alert_id":"636b9d5de2cf8328549503b9","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"SMS":{"recipient":"123456789","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}}}}'
#response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, data=data)require 'net/http'
require 'json'
uri = URI('https://inform-api-0X.moengage.com/v1/send')
req = Net::HTTP::Post.new(uri)
req.content_type = 'application/json'
req['MOE-APPKEY'] = 'YOUR_APP_KEY_HERE'
req['Authorization'] = 'Basic Base64_ENCODED_APPKEY_APIKEY'
# The object won't be serialized exactly like this
# req.body = "{"alert_id":"636b9d5de2cf8328549503b9","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"SMS":{"recipient":"123456789","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}}}}"
req.body = {
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"SMS": {
"recipient": "123456789",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}.to_json
req_options = {
use_ssl: uri.scheme == "https"
}
res = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(req)
endimport java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
public class Main {
public static void main(String[] args) throws IOException {
URL url = new URL("https://inform-api-0X.moengage.com/v1/send");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod(“POST”);
httpConn.setRequestProperty(“MOE-APPKEY”, “YOUR_APP_KEY_HERE”);
httpConn.setRequestProperty(“Authorization”, “Basic Base64_ENCODED_APPKEY_APIKEY”);
httpConn.setRequestProperty(“Content-Type”, “application/json”);
httpConn.setDoOutput(true);
String payload = "{
\"alert_id\": \"636bc615e2cf83285495055f\",
\"alert_reference_name\": \"Demo_ID\",
\"user_id\": \"USER_ID\",
\"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",
\"payloads\": {
\"SMS\": {
\"recipient\": \"123456789\",
\"personalized_attributes\": {
\"firstname\": \"YOUR_firstname_ATTRIBUTE_VAL_HERE\",
\"userid\": \"YOUR_userid_ATTRIBUTE_VAL_HERE\",
\"deliverydate\": \"YOUR_deliverydate_ATTRIBUTE_VAL_HERE\",
\"deliveryslot_starttime\": \"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE\"
}
}
}
}";
httpConn.setDoOutput(true);
OutputStream os = httpConn.getOutputStream();
os.write(payload.getBytes());
os.flush();
InputStream responseStream = httpConn.getResponseCode() == HttpURLConnection.HTTP_OK
? httpConn.getInputStream()
: httpConn.getErrorStream();
BufferedReader br = new BufferedReader(new InputStreamReader(
(responseStream)));
String output;
while ((output = br.readLine()) != null) {
System.out.println(output);
}
httpConn.disconnect();
}
}Only Email Channel
curl --location --request POST 'https://inform-api-0X.moengage.com/v1/send' \
--header 'MOE-APPKEY: YOUR_APP_KEY_HERE' \
--header 'Authorization: Basic Base64_ENCODED_APPKEY_APIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"EMAIL": {
"recipient": "john.doe@moengage.com",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
},
"personalized_attachments": {
"order_summary": "YOUR_order_summary_VAL_HERE"
}
}
}
}'import fetch from 'node-fetch';
fetch('https://inform-api-0X.moengage.com/v1/send', {
method: 'POST',
headers: {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type': 'application/json'
},
// body: "{\n \"alert_id\": \"636b9d5de2cf8328549503b9\",\n \"alert_reference_name\": \"Demo_ID\",\n \"user_id\": \"USER_ID\",\n \"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",\n \"payloads\": {\n \"EMAIL\": {\n \"recipient\": \"john.doe@moengage.com\",\n \"personalized_attributes\": {\n \"firstname\": \"YOUR_firstname_ATTRIBUTE_VAL_HERE\",\n \"orderid\": \"YOUR_orderid_ATTRIBUTE_VAL_HERE\",\n \"deliverydate\": \"YOUR_deliverydate_ATTRIBUTE_VAL_HERE\",\n \"deliveryslot_starttime\": \"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE\",\n \"deliveryslot_endtime\": \"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE\"\n \"personalized_attachments\": {\n \"order_summary\": \"YOUR_order_summary_VAL_HERE\"\n }\n }\n }\n}",
body: JSON.stringify({
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"EMAIL": {
"recipient": "john.doe@moengage.com",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
},
"personalized_attachments": {
"order_summary": "YOUR_order_summary_VAL_HERE"
}
}
}
})
});package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"EMAIL": {
"recipient": "john.doe@moengage.com",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
},
"personalized_attachments": {
"order_summary": "YOUR_order_summary_VAL_HERE"
}
}
}
}`)
req, err := http.NewRequest("POST", "https://inform-api-0X.moengage.com/v1/send", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("MOE-APPKEY", "YOUR_APP_KEY_HERE")
req.Header.Set("Authorization", "Basic Base64_ENCODED_APPKEY_APIKEY")
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s
", bodyText)
}<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://inform-api-0X.moengage.com/v1/send');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'MOE-APPKEY' => 'YOUR_APP_KEY_HERE',
'Authorization' => 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type' => 'application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"alert_id":"636b9d5de2cf8328549503b9","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"EMAIL":{"recipient":"john.doe@moengage.com","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"},"personalized_attachments":{"order_summary":"YOUR_order_summary_VAL_HERE"}}}}');
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$response = curl_exec($ch);
curl_close($ch);import requests
headers = {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
# Already added when you pass json= but not when you pass data=
# 'Content-Type': 'application/json',
}
json_data = {
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"EMAIL": {
"recipient": "john.doe@moengage.com",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
},
"personalized_attachments": {
"order_summary": "YOUR_order_summary_VAL_HERE"
}
}
}
}
response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, json=json_data)
# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{"alert_id":"636b9d5de2cf8328549503b9","user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"EMAIL":{"recipient":"john.doe@moengage.com","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"},"personalized_attachments":{"order_summary":"YOUR_order_summary_VAL_HERE"}}}}'
#response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, data=data)require 'net/http'
require 'json'
uri = URI('https://inform-api-0X.moengage.com/v1/send')
req = Net::HTTP::Post.new(uri)
req.content_type = 'application/json'
req['MOE-APPKEY'] = 'YOUR_APP_KEY_HERE'
req['Authorization'] = 'Basic Base64_ENCODED_APPKEY_APIKEY'
# The object won't be serialized exactly like this
# req.body = "{"alert_id":"636b9d5de2cf8328549503b9","alert_reference_name": "Demo_ID", "user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"EMAIL":{"recipient":"john.doe@moengage.com","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"},"personalized_attachments":{"order_summary":"YOUR_order_summary_VAL_HERE"}}}}"
req.body = {
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"EMAIL": {
"recipient": "john.doe@moengage.com",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
},
"personalized_attachments": {
"order_summary": "YOUR_order_summary_VAL_HERE"
}
}
}
}.to_json
req_options = {
use_ssl: uri.scheme == "https"
}
res = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(req)
end
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
public class Main {
public static void main(String[] args) throws IOException {
URL url = new URL("https://inform-api-0X.moengage.com/v1/send");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod(“POST”);
httpConn.setRequestProperty(“MOE-APPKEY”, “YOUR_APP_KEY_HERE”);
httpConn.setRequestProperty(“Authorization”, “Basic Base64_ENCODED_APPKEY_APIKEY”);
httpConn.setRequestProperty(“Content-Type”, “application/json”);
httpConn.setDoOutput(true);
String payload = "{
\"alert_id\": \"636bc615e2cf83285495055f\",
\"alert_reference_name\": \"Demo_ID\",
\"user_id\": \"USER_ID\",
\"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",
\"payloads\": {
\"EMAIL\": {
\"recipient\": \"john.doe@moengage.com\",
\"personalized_attributes\": {
\"firstname\": \"YOUR_firstname_ATTRIBUTE_VAL_HERE\",
\"userid\": \"YOUR_userid_ATTRIBUTE_VAL_HERE\",
\"deliverydate\": \"YOUR_deliverydate_ATTRIBUTE_VAL_HERE\",
\"deliveryslot_starttime\": \"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE\"
},
\"personalized_attachments\": {
\"order_summary\": \"YOUR_order_summary_VAL_HERE\"
}
}
}
}";
httpConn.setDoOutput(true);
OutputStream os = httpConn.getOutputStream();
os.write(payload.getBytes());
os.flush();
InputStream responseStream = httpConn.getResponseCode() == HttpURLConnection.HTTP_OK
? httpConn.getInputStream()
: httpConn.getErrorStream();
BufferedReader br = new BufferedReader(new InputStreamReader(
(responseStream)));
String output;
while ((output = br.readLine()) != null) {
System.out.println(output);
}
httpConn.disconnect();
}
}Only Push Channel
curl --location --request POST 'https://inform-api-0X.moengage.com/v1/send' \
--header 'MOE-APPKEY: YOUR_APP_KEY_HERE' \
--header 'Authorization: Basic Base64_ENCODED_APPKEY_APIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}'import fetch from 'node-fetch';
fetch('https://inform-api-0X.moengage.com/v1/send', {
method: 'POST',
headers: {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
})
});package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}`)
req, err := http.NewRequest("POST", "https://inform-api-0X.moengage.com/v1/send", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("MOE-APPKEY", "YOUR_APP_KEY_HERE")
req.Header.Set("Authorization", "Basic Base64_ENCODED_APPKEY_APIKEY")
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s
", bodyText)
}<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://inform-api-0X.moengage.com/v1/send');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'MOE-APPKEY' => 'YOUR_APP_KEY_HERE',
'Authorization' => 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type' => 'application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"alert_id":"636b9d5de2cf8328549503b9","alert_reference_name": "Demo_ID","user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}}}}');
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$response = curl_exec($ch);
curl_close($ch);import requests
headers = {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
# Already added when you pass json= but not when you pass data=
# 'Content-Type': 'application/json',
}
json_data = {
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}
response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, json=json_data)
# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{"alert_id":"636b9d5de2cf8328549503b9","alert_reference_name": "Demo_ID","user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}}}}'
#response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, data=data)require 'net/http'
require 'json'
uri = URI('https://inform-api-0X.moengage.com/v1/send')
req = Net::HTTP::Post.new(uri)
req.content_type = 'application/json'
req['MOE-APPKEY'] = 'YOUR_APP_KEY_HERE'
req['Authorization'] = 'Basic Base64_ENCODED_APPKEY_APIKEY'
# The object won't be serialized exactly like this
# req.body = "{"alert_id":"636b9d5de2cf8328549503b9","alert_reference_name": "Demo_ID","user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}}}}"
req.body = {
"alert_id": "636b9d5de2cf8328549503b9",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}.to_json
req_options = {
use_ssl: uri.scheme == "https"
}
res = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(req)
endimport java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
public class Main {
public static void main(String[] args) throws IOException {
URL url = new URL("https://inform-api-0X.moengage.com/v1/send");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod(“POST”);
httpConn.setRequestProperty(“MOE-APPKEY”, “YOUR_APP_KEY_HERE”);
httpConn.setRequestProperty(“Authorization”, “Basic Base64_ENCODED_APPKEY_APIKEY”);
httpConn.setRequestProperty(“Content-Type”, “application/json”);
httpConn.setDoOutput(true);
String payload = "{
\"alert_id\": \"636bc615e2cf83285495055f\",
\"alert_reference_name\": \"Demo_ID\",
\"user_id\": \"USER_ID\",
\"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",
\"payloads\": {
\"PUSH\": {
\"recipient\": \"<push-token>\",
\"personalized_attributes\": {
\"firstname\": \"YOUR_firstname_ATTRIBUTE_VAL_HERE\",
\"userid\": \"YOUR_userid_ATTRIBUTE_VAL_HERE\",
\"deliverydate\": \"YOUR_deliverydate_ATTRIBUTE_VAL_HERE\",
\"deliveryslot_starttime\": \"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE\"
}
}
}
}";
httpConn.setDoOutput(true);
OutputStream os = httpConn.getOutputStream();
os.write(payload.getBytes());
os.flush();
InputStream responseStream = httpConn.getResponseCode() == HttpURLConnection.HTTP_OK
? httpConn.getInputStream()
: httpConn.getErrorStream();
BufferedReader br = new BufferedReader(new InputStreamReader(
(responseStream)));
String output;
while ((output = br.readLine()) != null) {
System.out.println(output);
}
httpConn.disconnect();
}
}
Case 2: Multiple channels are configured for the Alert
curl --location --request POST 'https://inform-api-0X.moengage.com/v1/send' \
--header 'MOE-APPKEY: YOUR_APP_KEY_HERE' \
--header 'Authorization: Basic Base64_ENCODED_APPKEY_APIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
},
"EMAIL": {
"recipient": "john.doe@moengage.com",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}'import fetch from 'node-fetch';
fetch('https://inform-api-0X.moengage.com/v1/send', {
method: 'POST',
headers: {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type': 'application/json'
},
// body: "{\n \"alert_id\": \"636b77e6e2cf83277195fb60\",\n \"alert_reference_name\": \"Demo_ID\",\n \"user_id\": \"USER_ID\",\n \"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",\n \"payloads\": {\n \"PUSH\": {\n \"recipient\": \"<push-token>\",\n \"personalized_attributes\": {\n \"firstname\": \"YOUR_firstname_ATTRIBUTE_VAL_HERE\",\n \"orderid\": \"YOUR_orderid_ATTRIBUTE_VAL_HERE\",\n \"deliverydate\": \"YOUR_deliverydate_ATTRIBUTE_VAL_HERE\",\n \"deliveryslot_starttime\": \"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE\",\n \"deliveryslot_endtime\": \"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE\"\n }\n },\n \"EMAIL\": {\n \"recipient\": \"john.doe@moengage.com\",\n \"personalized_attributes\": {\n \"firstname\": \"YOUR_firstname_ATTRIBUTE_VAL_HERE\",\n \"orderid\": \"YOUR_orderid_ATTRIBUTE_VAL_HERE\",\n \"deliverydate\": \"YOUR_deliverydate_ATTRIBUTE_VAL_HERE\",\n \"deliveryslot_starttime\": \"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE\",\n \"deliveryslot_endtime\": \"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE\"\n }\n }\n }\n}",
body: JSON.stringify({
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
},
"EMAIL": {
"recipient": "john.doe@moengage.com",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
})
});package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
},
"EMAIL": {
"recipient": "john.doe@moengage.com",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}`)
req, err := http.NewRequest("POST", "https://inform-api-0X.moengage.com/v1/send", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("MOE-APPKEY", "YOUR_APP_KEY_HERE")
req.Header.Set("Authorization", "Basic Base64_ENCODED_APPKEY_APIKEY")
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s
", bodyText)
}<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://inform-api-0X.moengage.com/v1/send');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'MOE-APPKEY' => 'YOUR_APP_KEY_HERE',
'Authorization' => 'Basic Base64_ENCODED_APPKEY_APIKEY',
'Content-Type' => 'application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"alert_id":"636b77e6e2cf83277195fb60","alert_reference_name": "Demo_ID","user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}},"EMAIL":{"recipient":"john.doe@moengage.com","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}}}}');
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$response = curl_exec($ch);
curl_close($ch);
import requests
headers = {
'MOE-APPKEY': 'YOUR_APP_KEY_HERE',
'Authorization': 'Basic Base64_ENCODED_APPKEY_APIKEY',
# Already added when you pass json= but not when you pass data=
# 'Content-Type': 'application/json',
}
json_data = {
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
},
"EMAIL": {
"recipient": "john.doe@moengage.com",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}
response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, json=json_data)
# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{"alert_id":"636b77e6e2cf83277195fb60","alert_reference_name": "Demo_ID","user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}},"EMAIL":{"recipient":"john.doe@moengage.com","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}}}}'
#response = requests.post('https://inform-api-0X.moengage.com/v1/send', headers=headers, data=data)require 'net/http'
require 'json'
uri = URI('https://inform-api-0X.moengage.com/v1/send')
req = Net::HTTP::Post.new(uri)
req.content_type = 'application/json'
req['MOE-APPKEY'] = 'YOUR_APP_KEY_HERE'
req['Authorization'] = 'Basic Base64_ENCODED_APPKEY_APIKEY'
# The object won't be serialized exactly like this
# req.body = "{"alert_id":"636b77e6e2cf83277195fb60","alert_reference_name": "Demo_ID","user_id":"USER_ID","transaction_id":"YOUR_TRANSACTION_ID_VAL_HERE","payloads":{"PUSH":{"recipient":"<push-token>","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}},"EMAIL":{"recipient":"john.doe@moengage.com","personalized_attributes":{"firstname":"YOUR_firstname_ATTRIBUTE_VAL_HERE","orderid":"YOUR_orderid_ATTRIBUTE_VAL_HERE","deliverydate":"YOUR_deliverydate_ATTRIBUTE_VAL_HERE","deliveryslot_starttime":"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE","deliveryslot_endtime":"YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"}}}}"
req.body = {
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient": "<push-token>",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
},
"EMAIL": {
"recipient": "john.doe@moengage.com",
"personalized_attributes": {
"firstname": "YOUR_firstname_ATTRIBUTE_VAL_HERE",
"orderid": "YOUR_orderid_ATTRIBUTE_VAL_HERE",
"deliverydate": "YOUR_deliverydate_ATTRIBUTE_VAL_HERE",
"deliveryslot_starttime": "YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE",
"deliveryslot_endtime": "YOUR_deliveryslot_endtime_ATTRIBUTE_VAL_HERE"
}
}
}
}.to_json
req_options = {
use_ssl: uri.scheme == "https"
}
res = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(req)
endimport java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
public class Main {
public static void main(String[] args) throws IOException {
URL url = new URL("https://inform-api-0X.moengage.com/v1/send");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod(“POST”);
httpConn.setRequestProperty(“MOE-APPKEY”, “YOUR_APP_KEY_HERE”);
httpConn.setRequestProperty(“Authorization”, “Basic Base64_ENCODED_APPKEY_APIKEY”);
httpConn.setRequestProperty(“Content-Type”, “application/json”);
httpConn.setDoOutput(true);
String payload = "{
\"alert_id\": \"636bc615e2cf83285495055f\",
\"alert_reference_name\": \"Demo_ID\",
\"user_id\": \"USER_ID\",
\"transaction_id\": \"YOUR_TRANSACTION_ID_VAL_HERE\",
\"payloads\": {
\"PUSH\": {
\"recipient\": \"<push-token>\",
\"personalized_attributes\": {
\"firstname\": \"YOUR_firstname_ATTRIBUTE_VAL_HERE\",
\"userid\": \"YOUR_userid_ATTRIBUTE_VAL_HERE\",
\"deliverydate\": \"YOUR_deliverydate_ATTRIBUTE_VAL_HERE\",
\"deliveryslot_starttime\": \"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE\"
}
},
\"EMAIL\": {
\"recipient\": \"john.doe@moengage.com\",
\"personalized_attributes\": {
\"firstname\": \"YOUR_firstname_ATTRIBUTE_VAL_HERE\",
\"userid\": \"YOUR_userid_ATTRIBUTE_VAL_HERE\",
\"deliverydate\": \"YOUR_deliverydate_ATTRIBUTE_VAL_HERE\",
\"deliveryslot_starttime\": \"YOUR_deliveryslot_starttime_ATTRIBUTE_VAL_HERE\"
}
}
}
}";
httpConn.setDoOutput(true);
OutputStream os = httpConn.getOutputStream();
os.write(payload.getBytes());
os.flush();
InputStream responseStream = httpConn.getResponseCode() == HttpURLConnection.HTTP_OK
? httpConn.getInputStream()
: httpConn.getErrorStream();
BufferedReader br = new BufferedReader(new InputStreamReader(
(responseStream)));
String output;
while ((output = br.readLine()) != null) {
System.out.println(output);
}
httpConn.disconnect();
}
}Response Parameters
| Key | Description |
|---|---|
|
message |
This field contains a brief description of the request status. |
|
request_id |
This field contains the unique identifier for the request and is present in the response body only for the following cases:
|
|
err_code |
This field is present in the response body only when the request is unsuccessful and contains the error code. |
Response Codes
| Status Code | Request State | Description |
|---|---|---|
|
200 |
Success |
This response is returned when the request is submitted to MoEngage and the channel-level details are present in the API Response Details. Note: For errors in the channel-level payload, the error information is present in the logs on the dashboard. To learn more, see API Response Details. |
|
400 |
Bad Request |
This response is returned in the following cases:
|
|
401 |
Authorization Failed |
This response is returned when the authorization fails due to incorrect values for the APP KEY/ HTTP Auth Header. |
|
409 |
Duplicate Request |
This response is returned when a request is sent with the same transaction_id value as a previously successful or in-progress request. For more information, refer to Duplicate requests. |
|
429 |
Rate Limit Reached |
This response is returned when the number of requests per minute has exceeded the rate limit. |
|
500 |
Internal Server error |
This response is returned when the system runs into an unexpected error. You can try for a maximum of 3 times with exponential backoff. |
How Does Inform API Work & Respond?
| info |
Info Reach out to your Customer Success Manager to enable sending the channel level details as part of your API response. |
Inform API works in two steps as described below:
- A check is performed to verify if the API request received for Inform is valid.
- If valid, the second process is to resolve the content and send a message using the partner.
The response codes are shared in wxyzab format as described below:
w - Status (failures are indicated with 1 and success is indicated with 2)
x - Category of the error
y - Request is considered for parallel request (parallel requests is indicated with 0 and fallback requests are indicated with 1)
z - Can this request be retried by you(0 indicates it cannot be retried with same details)
ab - Reason details for the error
Below are the Category details:
| Category Code | Details |
|---|---|
| 1 | Unauthorized |
| 2 | Bad Request |
| 4 | Internal Server Error / Ratelimit |
The Reason details are given below with each Reason Code holding specific meanings:
| Reason Code | Details |
|---|---|
| 1 | Invalid Credentials |
| 2 | Invalid Alert ID |
| 3 | Missing Transaction ID |
| 4 | Duplicate Transaction ID |
| 5 | Long Transaction ID |
| 6 | Invalid Payload |
| 7 | Personalisation Attribute |
| 9 | Internal Server Error |
| 10 | Rate Limit |
| 11 | Personalisation Failed |
| 12 | Invalid Recipient details |
| 13 | Vendor configuration errors |
| 14 | Vendor not available |
| 15 | Vendor Payload Rejection |
| 16 | Unexpected Error Occurred |
| 17 | Invalid Origin Source |
Payload Errors Before Accepting the API Request
The list of the payload errors that can occur before accepting the API request and the equivalent response codes to be shared under HTTP status code 4xx for different scenarios across each functionality is given below:
| Payload Errors | Description | Scenarios | Response Codes | Resolution |
|---|---|---|---|---|
|
Authorization Failure |
This error occurs when invalid authorization details such as App Key (Workspace ID) or Password are shared. |
|
{ "message": "Authorization Failed", "err_code": "UNAUTHORIZED" } | Recheck the authorization details listed in Settings / Check if you passed the Test Alert ID on Live Endpoint. |
|
Invalid Alert ID |
This error occurs when an invalid Alert ID or external reference name is shared. |
|
{"message": "Invalid Alert ID“, "err_code": "BAD_REQUEST", “status_code”:120002} | Recheck the Alert ID or external reference name listed on the Info page. |
|
Invalid Transaction ID |
This error occurs when the Transaction ID is not shared. |
Missing Transaction ID | {"message": "Invalid Transaction ID“, "err_code": "BAD_REQUEST", “status_code”:120003} |
Share the transaction ID using the key name transaction_id as part of the API Call.
|
|
Long Transaction ID |
This error occurs when the Transaction ID is invalid. |
Long Transaction ID | {"message": "Long Transaction ID“, "err_code": "BAD_REQUEST", “status_code”:120004} |
Reduce the length of the Transaction ID to 50 characters. |
|
Duplicate Transaction ID |
This error occurs when the currently shared Transaction ID matches the previous one in the last 5 minutes. |
Duplicate Transaction ID | {"message": "Duplicate Transaction ID“, "err_code": "DUPLICATE_REQUEST_RECEIVED", “status_code”:120105} | Add a unique Transaction ID. |
|
Invalid Payload |
This error occurs when the payload is in incorrect JSON format or when incorrect Channel details are shared. |
|
{"message": "Invalid Payload“, "err_code": "BAD_REQUEST", “status_code”:120006} |
Recheck the JSON format and the Channel details. Sample payload is available on our Info page. |
|
Personalisation Attribute Max length |
This error occurs when the Personalization Attribute length is greater than 1500 characters. |
{"message": "Personalisation attribute limit exceeded - {x}“, "err_code": "BAD_REQUEST", “status_code”:120007} | Reduce the length of the Personalization Attribute to 1500 characters / payload size of <100 KB | |
|
Invalid Recipient |
This error occurs when the recipient details like mobile number or email address are invalid. |
{"message": "Invalid Recipient“, "err_code": "BAD_REQUEST", “status_code”:120012} | Recheck the recipient details in the API call or the User Profile. | |
|
Internal Server Error |
This error occurs when MoEngage is not able to resolve the API request. |
{"message": "Unexpected error occurred“, "err_code": "Internal Server Error", “status_code”:140109} | Retry using the same API call with a different Transaction ID. | |
|
Rate Limit |
This error occurs when you cross the Rate Limit. |
{"message": "Too many requests“, "err_code": "Rate Limit", “status_code”:140110} | Make API calls within the Rate Limit. |
Payload Errors After Accepting the API Request
Alerts can be configured for parallel/sequential fallback as described below:
- Parallel: For parallel requests, the payload information of success/failure requests should be added at each channel level.
- Sequence: For fallback requests, the payload information of success/failure requests should be added for the first channel, and other channels, info should be shared over streams
The list of the payload details that can occur after accepting the API request and the equivalent response codes to be shared under HTTP status code 200/429 for different scenarios across each functionality is given below:
| Payload Errors | Description | Response Codes | Resolution |
|---|---|---|---|
| Personalisation Failed | This error occurs when the required Personalization attributes are not shared in the API call or User Profile doesn't have these values. | {"message": "Successfully Received“, “Request_ID”: 122323, SMS: {"message": "Personalisation Failure - {{attribute name}}“, "err_code": "BAD_REQUEST", “status_code”:120011 / 121011}} | Either share the valid Personalization attributes in the API call or update the User Profile with the required values. |
| Invalid Recipient details | This error occurs when the recipient details like mobile number or email address are invalid. | {"message": "Successfully Received” , “Request_ID”: 122323, SMS: {"message": "Invalid Recipient“, "err_code": "BAD_REQUEST", “status_code”:120012 / 121012} | Recheck the recipient details in the API call or the User Profile. |
| Internal Errors | This error occurs when MoEngage is not able to resolve the API request or channel level details. | {"message": "Successfully Received”, “Request_ID”: 122323, SMS: {"message": "Unexpected error occurred“, "err_code": "Internal Server Error", “status_code”:140109 / 141109}} | Retry using the same API call with a different Transaction ID. |
|
Vendor Errors |
This error occurs when the vendor configuration is invalid.
|
{"message": "Successfully Received”, “Request_ID”: 122323, SMS: {"message": "Invalid Vendor Configuration“, "err_code": "Vendor Error", “status_code”:150013 / 151013}} |
Recheck the vendor configuration in MoEngage for SMS, Push, and Email. |
| This error occurs when the vendor is not available. | {"message": "Successfully Received”, “Request_ID”: 122323, SMS: {"message": "Vendor not available“, "err_code": "Vendor Error", “status_code”:150014 / 151014}} | NA/MoEngage will retry up to 5 times to submit the message to the vendor. | |
| This error occurs when the vendor rejects the Payload. | {"message": "Successfully Received”, “Request_ID”: 122323, SMS: {"message": "Rejected by Vendor with error - {{error from vendor}},“, "err_code": "Vendor Error", “status_code”:150015 / 151015}} | Resolve the error sent by the vendor and then make the API call. | |
| This is sent as response when vendor accepts the request | {"message": "Successfully Received”, “Request_ID”: 122323, SMS: {"message": "Successfully sent“, "err_code": "NA", “status_code”:200000}} |
Postman Collection
We have made it easy for you to test the APIs. Click here to view it in Postman.
FAQs
-
What is the Rate Limit?
The default rate limit is 10K RPM. -
How are Duplicate Requests handled?
A request is deemed duplicate in the case following cases:
-
- It is received within 5 minutes of a previously successful request containing the same transaction_id
- It is received within 5 minutes of a previous request which is ‘In Progress’ (being processed) and contains the same transaction_id
Duplicate requests are dropped and not reprocessed.
-
What happens when a vendor does not accept requests from MoEngage?
When the vendor does not accept requests from MoEngage, MoEngage retries every request a maximum of five times with 200ms exponential backoff. -
Are Alert Logs stored in MoEngage?
Alert logs are stored for up to 30 days for every Alert in MoEngage. -
Error - Live Alert Request received on Sandbox API endpoint
This error occurs when you hit the live alert ID at the sandbox endpoint. For every alert, there are 2 IDs: one is live, and another is Test; the same behavior can be seen for alerts created on the test environment of the MoEngage Dashboard as well. Test Alert ID can be picked up by editing the Alert and going to the 3rd page.