Use a REST project key from your backend. Target users by external ID, segments, or filters.
Send a push notification
http
POST /api/notifications
Authorization: Bearer ek_rest_...
Content-Type: application/json
{
"include_external_user_ids": ["user-123"],
"headings": { "en": "Hello" },
"contents": { "en": "Your order has shipped." },
"data": { "order_id": "ord_456" }
}Common fields
| Field | Description |
|---|---|
include_external_user_ids | Array of your backend user IDs |
headings / contents | Localized title and body (locale keys, e.g. en) |
data | Custom payload; includes ek_message_id for receipts automatically |
channel | PUSH (default), SMS, EMAIL |
Checking delivery
Each attempt is logged as a MessageDelivery. In the dashboard, open Deliveries to filter by status, channel, or user. Failed rows include error codes (e.g. apns_403_InvalidProviderToken) and operator hints.
lightbulb
Tip
Full request/response schemas are available in Swagger at
/api/docs when the API is running locally.