Docs / Getting Started

Quick Start

Get notifly sending notifications in under two minutes.

Install

terminal
npm install @ambersecurityinc/notifly

Send your first notification

Import notify and pass a list of notification URLs along with your message. Every URL is dispatched concurrently and results are returned in order.

send.ts
import { notify } from '@ambersecurityinc/notifly';

const results = await notify(
  {
    urls: [
      'discord://1234567890/your_webhook_token',
      'ntfy://my-alerts',
    ],
  },
  {
    title: 'Hello from notifly',
    body: 'Your first notification!',
    type: 'success',
  }
);

console.log(results);
// [
//   { success: true, service: 'discord' },
//   { success: true, service: 'ntfy' },
// ]

What just happened?

  • notify() accepted an options object with urls — a list of notification URLs — and a message object.
  • Both services were called concurrently via Promise.allSettled.
  • Each result has a success boolean, the service name, and an optional error string.

Notification types

The type field maps to service-native message levels where supported:

Type Description
info Default informational message
success Positive outcome
warning Something needs attention
failure Error or critical alert

Next steps

  • Installation — runtimes, TypeScript, bundle size
  • API Reference — full documentation for every export
  • Services — URL scheme formats for all 10 supported services
  • Builder — headless URL builder for building your own UI
Next → Installation