Pingui Alert SDK

Official SDK to integrate Pingui Alert into your Node.js applications.

Installation

npm install pingui-alert-sdk

Usage

import { PinguiAlert } from 'pingui-alert-sdk';

// Initialize the client
const alert = new PinguiAlert({
  chatId: 'your-chat-id',
  token: 'your-token',
  baseUrl: 'https://pingui-alert.dev' // Optional
});

// Send an alert
await alert.sendAlert('Alert message', 'Optional title');

// Validate status and quota
const status = await alert.validateStatus();
console.log(status);

API

Constructor

new PinguiAlert(config: PinguiAlertConfig)

Parameters:

• chatId (string | number): Target chat ID
• token (string): Authentication token
• baseUrl (string, optional): Service base URL (default: 'https://pingui-alert.dev')

Methods

sendAlert(message: string, title?: string): Promise<void>

Sends an alert to the configured chat.

Parameters:

• message (string): Message content
• title (string, optional): Alert title

Example:

await alert.sendAlert('Server error', 'Critical Error');

validateStatus(): Promise<object>

Validates the integration status and available quota.

Returns:

{
  remainingAlerts: number | 'N/A',
  success: boolean
}

Example:

const { remainingAlerts, success } = await alert.validateStatus();
if (success) {
  console.log(`Remaining alerts: ${remainingAlerts}`);
}

License

ISC