NotifyMe API Reference

Every payload field in one place.

Use any device API key from the app’s API Keys screen as a Bearer token. This documentation covers the full request shape, routing variables, multi-button actions, reply options, and callback fields.

NotifyMe Home

Access

Every request is sent over HTTPS and scoped to the device that owns the API key.

Endpoint

HTTP

Always

POST https://www.nextgenaischool.in/api/notifyme/send

Authorization

Header

Always

Bearer <YOUR_DEVICE_API_KEY>

Content-Type

Header

Always

application/json

Core Fields

These fields define the notification content and its main tap behavior.

title

string

Yes

Notification title shown in Android and stored in app history.

body

string

Yes

Main message text shown in the notification and history list.

notificationId

string

Optional stable identifier for your own correlation, dedupe, or callback tracking.

actionType

enum

Main action when the notification body is tapped. Defaults to open_history.

Supported actionType Values

Choose one of these for the primary notification tap.

open_home

actionType

Supported

Opens the main NotifyMe screen.

open_history

actionType

Supported

Opens the app directly on Notification History.

open_updates

actionType

Supported

Opens the app and immediately checks for updates.

open_token

actionType

Supported

Opens the API Keys screen.

open_url

actionType

Supported

Opens the URL provided by url. Only valid http and https links are accepted.

open_custom

actionType

Supported

Routes to an internal screen using customRoute.

Routing Fields

Use these only when the chosen actionType requires them.

url

string

When actionType=open_url

Network URL opened in the browser.

customRoute

string

When actionType=open_custom

Supported values include updates, token, api-keys, history, docs, and api-docs.

Buttons and Reply Fields

Use these for direct interaction from the notification shade.

buttons

array<object>

Ordered list of quick-action buttons. NotifyMe now supports multiple buttons on the same notification.

buttons[].label

string

Inside buttons

Visible text rendered on each button.

buttons[].action

string

Inside buttons

Machine-readable action id stored in history and returned through callback flows.

buttonLabel

string

Legacy optional

Backward-compatible single-button label. If paired with buttonAction, NotifyMe treats it as one buttons entry.

buttonAction

string

Legacy optional

Backward-compatible single-button action id.

textReplyEnabled

boolean

When true, adds an inline reply action to the notification.

textReplyLabel

string

Optional label for the reply action. Defaults to Reply.

Callback Fields

Use these when your server needs to receive button presses or replies after delivery.

callbackUrl

string

Backend callback destination for user response events.

callbackSecret

string

Optional shared secret for validating the callback flow on your server.

Notes

The Android app also ships with the same docs screen so this reference is available in-app.
Use actionType: "open_history" when a notification should land directly on the history screen.
Android typically renders the first few quick-action buttons, so keep the buttons array concise.
Legacy single-button payloads still work, but the new multi-button format is preferred going forward.