Code Samples

Use a public_client API key for the public-notify endpoint shown below.

wordpress_server and strapi_server keys are for signed integrations and will be rejected here.

Production endpoint

Use https://api.notificator-project.com as the canonical public endpoint.

Node.js package

Install the official client when integrating from a Node.js application, serverless function, queue worker, or backend service:

npm install @notificator-project/api

The current package release is 0.1.0. Its source and release notes are in the Node SDK repository.

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

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

await notificator.notify({
  title: "Build Succeeded",
  body: "CI pipeline completed successfully.",
  source: "github_actions",
  category: "info",
  data: { workflow: "deploy.yml", branch: "main" },
});

The package sends requests to the hosted Notificator endpoint. Keep API keys on the server and out of browser bundles. Infrastructure credentials used for mobile push, storage, email, and device delivery remain inside the hosted service and are never required by SDK users.

JavaScript (fetch)

const endpoint = "https://api.notificator-project.com";
const apiKey = process.env.NOTIFICATOR_API_KEY;

const payload = {
  title: "Build Succeeded",
  body: "CI pipeline completed successfully.",
  source: "github_actions",
  serviceName: "GitHub Actions",
  eventName: "BuildSucceeded",
  category: "info",
  severity: "info",
  data: {
    workflow: "deploy.yml",
    branch: "main"
  }
};

const response = await fetch(endpoint, {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${apiKey}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify(payload),
});

console.log(response.status, await response.json());

TypeScript

type PublicNotifyPayload = {
  title: string;
  body?: string;
  source?: string;
  category?: "info" | "task" | "promo";
  severity?: "info" | "warning" | "error" | "critical";
  serviceName?: string;
  eventName?: string;
  data?: Record<string, unknown>;
};

export async function sendPublicNotify(payload: PublicNotifyPayload) {
  const endpoint = "https://api.notificator-project.com";
  const apiKey = process.env.NOTIFICATOR_API_KEY;

  const res = await fetch(endpoint, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify(payload),
  });

  const result = await res.json();
  if (!res.ok) throw new Error(JSON.stringify(result));
  return result;
}

PHP (cURL)

<?php
$endpoint = 'https://api.notificator-project.com';
$apiKey = 'wpnotif_YOUR_API_KEY';

$payload = [
  'title' => 'Payment Provider Down',
  'body' => 'Checkout API is returning 503 errors.',
  'source' => 'wordpress_plugin',
  'serviceName' => 'Checkout Worker',
  'eventName' => 'ProviderDown',
  'category' => 'task',
  'severity' => 'critical',
  'data' => [
    'provider' => 'Stripe',
    'region' => 'eu-west-1',
  ],
];

$ch = curl_init($endpoint);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . $apiKey,
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_TIMEOUT => 15,
]);

$responseBody = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo "HTTP $httpCode\n";
echo $responseBody . "\n";

Postman

• Method: POST
• URL: https://api.notificator-project.com

Tip for shared configs

Store the endpoint in an environment variable and reuse it across services to avoid drift between environments.

Payload must not be empty

Send at least one meaningful notification field such as title, body, message, category, severity, or non-empty payload/data.

Requests with only delivery flags like sendPush or sendMqtt return 400.

• Headers:
  • Authorization: Bearer {{wpnotif_api_key}}
  • Content-Type: application/json

Body (raw JSON):

{
  "title": "Postman Push Test",
  "body": "This should send push + MQTT.",
  "source": "postman_manual",
  "sendPush": true,
  "sendMqtt": true,
  "service": "billing",
  "region": "eu-west-1"
}