Push-notification payload definitions for ESP RainMaker Neo, from the mobile app's
perspective: the provider-native JSON the device receives, by
integration_type.
integration_type |
Provider | Payload shape |
|---|---|---|
apns |
Apple | aps + event_data |
apns_sandbox |
Apple | identical to apns |
gcm |
data (+ android) |
apns_sandbox is the development variant of apns (same payload). FCM and
GCM are the same Google (Firebase) integration.
GET /v1/integrations — discover the integration_id for the app's provider.PUT /v1/integrations/{integrationId}/endpoints — register the device token.AWS SNS. ESP RainMaker Neo publishes one formatted payload per provider to the registered SNS endpoint; SNS forwards it to APNS (Apple, over HTTP/2) or FCM (Google, over HTTP) for delivery to the device. This is the only server ESP RainMaker Neo contacts; the provider gateways are reached by SNS, not directly.
AWS region of the ESP RainMaker Neo deployment.
APNS payload, delivered to devices registered against an apns or apns_sandbox integration (the payload is identical for both).
Available only on servers:
Accepts the following message:
Node raised an alert
{
"aps": {
"alert": {
"title": "Node Alert",
"body": "Node ABCDEF1234567890 has an alert!"
},
"sound": "default",
"mutable-content": 1,
"category": "node_alert",
"thread-id": "ABCDEF1234567890.node.alert"
},
"event_data": {
"type": "node_alert",
"ts": 1743656583,
"data": {
"nodeID": "ABCDEF1234567890"
},
"notif_grp_id": "ABCDEF1234567890.node.alert"
}
}
Test notification
{
"aps": {
"alert": {
"title": "ESP RainMaker",
"body": "Test Message"
},
"sound": "default",
"mutable-content": 1
},
"event_data": {
"type": "test",
"ts": 1743656583,
"data": {}
}
}
FCM (GCM) payload, delivered to devices registered against a gcm integration.
Available only on servers:
Accepts the following message:
A data message (no FCM notification block), rendered by the app.
Node raised an alert
{
"data": {
"title": "Node Alert",
"body": "Node ABCDEF1234567890 has an alert!",
"event_data": {
"type": "node_alert",
"ts": 1743656583,
"data": {
"nodeID": "ABCDEF1234567890"
},
"notif_grp_id": "ABCDEF1234567890.node.alert"
}
},
"android": {
"priority": "high"
}
}
Test notification
{
"data": {
"title": "ESP RainMaker",
"body": "Test Message",
"event_data": {
"type": "test",
"ts": 1743656583,
"data": {}
}
}
}
A data message (no FCM notification block), rendered by the app.
ESP RainMaker Neo event fields. APNS carries this at the top level; FCM nests it under data.event_data.
A data message (no FCM notification block), rendered by the app.