Getting Started

Send your first notification in under 5 minutes.

1

Create an Account

Sign up for a free account to get started.

Create Account
2

Get Your API Key

  1. Navigate to your project in the Dashboard
  2. Go to Settings → API Keys
  3. Click Create New Key
  4. Copy and save your API key securely

Your API key will only be shown once. Store it securely!

3

Install the SDK

npm install @notification-system/sdk
4

Send Your First Notification

import { NotificationClient } from '@notification-system/sdk';

const client = new NotificationClient({
  apiKey: 'ntf_your_api_key_here',
});

const response = await client.notifications.send({
  type: ['email'],
  content: 'Hello from Notification System!',
  target: ['recipient@example.com'],
});

console.log('Notification ID:', response.id);
5

Check Status

Check the delivery status of your notification:

curl https://api.notifications.example.com/v1/notifications/{id} \
  -H "X-API-Key: ntf_your_api_key_here"