Sign in
Notifications

Send an in-app notification to one trainee, immediately or on a schedule. Requires the notifications:send scope, which is separate from messaging:send (WhatsApp). Each trainee accepts at most 10 API-sent notifications per day; over that the endpoint returns 429. High-risk — anyone with the key can deliver push notifications to your trainees.

post/api/public/notifications

Headers

Idempotency-Keystring

Optional. Send a unique key (e.g. a UUID) to make this POST safe to retry. The same key within 24h returns the original result instead of creating a duplicate.

Request body

traineeIdstring required
titlestring required

Short notification title

messagestring required

Body text

type'push' | 'popup' | 'both'

Delivery style. "push" (default) is a standard push notification, "popup" shows an in-app popup card, "both" sends a push and shows the popup. Never sends WhatsApp.

scheduledAtstring

Shorthand for a single future delivery: an ISO date-time. Use schedule instead for recurring sends. Cannot be combined with schedule.

Response

Created

Changes

No recorded changes to this endpoint across all 1 revision of this API.