Documentation

Send your first notification in under a minute. All requests use HTTPS and a bearer token.

Quickstart

Authenticate with the API key from your dashboard, then POST a payload to the delivery endpoint.

curl https://api.node-push.com/v1/messages \
  -H "Authorization: Bearer np_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{ "to": "device_8f21", "title": "Build passed", "body": "deployed" }'

import { NodePush } from "node-push";
const np = new NodePush(process.env.NODE_PUSH_KEY);
await np.messages.send({
  to: "device_8f21",
  title: "Build passed",
  body: "deployed",
});

import nodepush
np = nodepush.Client(api_key="np_live_xxx")
np.messages.send(
    to="device_8f21",
    title="Build passed",
    body="deployed",
)

Endpoints

Method	Path	Description
`POST`	`/v1/messages`	Queue a notification for delivery
`GET`	`/v1/messages/:id`	Fetch delivery status & receipt
`POST`	`/v1/webhooks`	Register a signed event subscription
`GET`	`/v1/health`	Service health probe

Webhook signatures

Every event carries an X-Np-Signature header. Verify it against your signing secret before trusting the payload.

const ok = verifyHmac(req.headers["x-np-signature"], rawBody, signingSecret);
if (!ok) return res.status(401).end();