Notificator Node.js SDK

Send alerts from Node.js, serverless functions, workers, queues, and backend applications to the Notificator mobile app and connected devices.

The SDK connects to the hosted Notificator API. Notificator operates the delivery service and securely manages mobile push, account email, and connected-device delivery.

The current package is available from npm, with release notes published on GitHub.

Install

npm install @notificator-project/api

Send an alert

import { NotificatorClient } from "@notificator-project/api";

const notificator = new NotificatorClient({
  apiKey: process.env.NOTIFICATOR_API_KEY,
});

await notificator.notify({
  title: "Deployment complete",
  body: "Version 2.4.1 is live.",
  source: "deploy-worker",
  category: "info",
  data: { version: "2.4.1", environment: "production" },
});

Use a public_client API key created in the web dashboard (beta) or Notificator mobile app. Both use the same account; the dashboard also lets you read notifications and monitor devices. Keep it on the server and never include it in browser or mobile bundles.

The SDK never contains or requests Notificator infrastructure credentials such as Expo, Supabase, email-provider, or MQTT service secrets.

Delivery controls

await notificator.notify({
  title: "Queue needs attention",
  body: "The order queue exceeded its threshold.",
  severity: "warning",
  sendPush: true,
  sendEmail: true,
  sendMqtt: true,
  deviceId: "optional-target-device-id",
});

Email delivery follows the account preference unless sendEmail is explicitly supplied. MQTT can target all active devices or a single owned device.

To use the encrypted HiveMQ Cloud connection saved to the same Notificator account as the API key, set mqttConnectionMode: "account" when creating the client. The API key must belong to the account that saved the connection; the broker password is never returned to the SDK or stored in your application.

const notificator = new NotificatorClient({
  apiKey: process.env.NOTIFICATOR_API_KEY,
  mqttConnectionMode: "account",
});

await notificator.notify({
  title: "Build complete",
  body: "The production build finished.",
  sendMqtt: true,
});

See the Public Notify API documentation for the complete payload and response contract.

Requirements

• Node.js 20 or newer
• A server-side public_client API key
• Network access to https://api.notificator-project.com

Development

npm install
npm test
npm run format:check
npm pack --dry-run

Security

Only use the SDK in trusted server-side code. If an API key is exposed, revoke it in the web dashboard or Notificator mobile app and create a replacement.