Nostria Service

Reliable Web Push notifications for Nostr users

About the Service

Nostria Service provides reliable web push notifications for Nostr users. The service utilizes the Web Push protocol and VAPID (Voluntary Application Server Identification) to deliver secure, verifiable notifications to users across devices.

Features

📲

Web Push Notifications

Receive real-time notifications across devices with the Web Push protocol.

🔒

VAPID Protocol

Verifiable and secure notifications with cryptographic verification.

Premium Features

Enhanced notification limits and custom filtering options for premium users.

⚙️

Notification Settings

Control how and when you receive notifications with customizable settings.

API Endpoints

The following endpoints are available for developers:

Method Endpoint Description
GET /api/status Get service information and status
GET /api/status/health Health check endpoint
GET /api/key Get service public key (VAPID)
POST /api/notification/send Send notifications to users (API key required)
POST /api/subscription/webpush/:pubkey Register a web push subscription for a user's device
GET /api/subscription/devices/:pubkey Get all registered devices for a user
GET /api/subscription/settings/:pubkey Get a user's notification settings
POST /api/subscription/settings/:pubkey Update a user's notification settings
DELETE /api/subscription/webpush/:pubkey/:deviceKey Delete a specific device subscription for a user

Note: API endpoints require NIP-98 HTTP Authentication.

Authentication

This API uses NIP-98 HTTP Authentication for secure access to endpoints:

For more details on implementation, see the NIP-98 Specification.

Getting Started

To use the Nostria Notification Service, you need to:

  1. Register a Web Push subscription with your Nostr public key
  2. Configure your notification preferences
  3. Ensure your app or service integrates with the notification API

For developers who want to send notifications, you need to authenticate using the API key. Please contact the service administrator for API access.

Send Notification

Use this form to manually send notifications to users. Requires API key authentication.

Enter Nostr public keys separated by commas, or leave empty to send to all registered users
URL to open when the notification is clicked
This key will be sent as the x-api-key header