Sending notifications

Same request as OneSignal: in your backend, change the URL and the key.

On this page

Audience
Supported fields
Credit
Notification log and recipients
Other endpoints

bash

curl https://takeed-iq.com/api/v1/notifications \
  -H "Authorization: Key $TAKEED_KEY" -H "Content-Type: application/json" \
  -d '{
    "app_id": "YOUR-APP-ID",
    "target": "shop:north",
    "headings": {"en": "Order shipped", "ar": "تم شحن الطلب"},
    "contents": {"en": "Arrives tomorrow", "ar": "يصل غداً"},
    "include_aliases": {"external_id": ["user-42"]},
    "data": {"order_id": "7"},
    "buttons": [{"id": "track", "text": "Track"}],
    "big_picture": "https://cdn.example.com/box.jpg"
  }'

Response: {"id": "...", "recipients": 1, "status": "queued"}.

Audience#

Field	Meaning
`included_segments` / `excluded_segments`	`"All"`, `"Subscribed Users"`, `"Active Users"`, `"Inactive Users"`, `"Test Users"`, or your segments
`include_aliases.external_id`	Up to 2000 External IDs (`include_external_user_ids` works too)
`filters`	Conditions on `tag`, `language`, `country`, `session_count`, `last_session`, `first_session`, `app_version`, `device_type`, `branch`; `{"operator": "OR"}` starts a new group
`target`	`"app:branch"` limits any of the above to one branch

Supported fields#

app_id, headings, contents, subtitle, include_aliases.external_id, include_external_user_ids, target_channel (push), included_segments, excluded_segments, filters, data, url, web_url, app_url, big_picture, large_icon, small_icon, chrome_web_icon, chrome_web_image, chrome_web_badge, ios_attachments, buttons (3), web_buttons (2), android_channel_id, android_accent_color, android_sound, android_group, ios_sound, ios_badgeType, ios_badgeCount, thread_id, ios_interruption_level, send_after, ttl, priority, collapse_id.

Credit#

Notifications are free and unlimited: they use no credit, and no limit applies to them.

Notification log and recipients#

The app's Notification log shows recipient, sent, delivered, failed and opened totals. Open one notification to inspect its recipients, device types and platforms, the state of each attempt and a plain failure reason such as missing key, credentials, uninstalled app, rejected request or unreachable device.

Other endpoints#

GET /api/v1/notifications?app_id=…: list notifications, up to 50 per request.
GET /api/v1/notifications/{id}?app_id=…: details with sent, delivered, failed and opened counts.
DELETE /api/v1/notifications/{id}?app_id=…: cancel a scheduled or sending notification.
GET /api/v1/apps/{app_id}/segments: also usable to check that a key works.
/api/v1/apps/{app_id}/users/by/external_id/{id}: read, update tags, delete a user.