HIhiyd
Notifications

Send a notification to yourself

Queues the notification in the push outbox and, unless schedule_at is in the future, delivers it in the request to every registered installation of the user (falling back to the legacy fcm_token). Future-scheduled notifications are delivered by the dispatcher at their time. schedule_at may be at most 7 days ahead, and a user may have at most 10 notifications from this endpoint waiting to be sent.

post/api/notifications/send

Request

  • Base URL
    https://api.hiyd.ai
  • Auth
    HTTP bearer

Request body

titlestring required
messagestring required
type'health_alert' | 'goal_reminder' | 'achievement' | 'social' | 'system' required
priority'low' | 'medium' | 'high' | 'urgent'
schedule_atstring date-time

Optional future delivery time, at most 7 days ahead

metadataobject

Response

Notification row created. Delivery outcome is in push; notification.status is the row's status afterwards (pending when scheduled or deferred, sent, failed, skipped, suppressed, ...).

Changes

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