Notifications

Subscriber Management

Manage the people who receive notifications about your service status. Subscribers sign up from your public status page and verify their email before receiving alerts.

How Subscriptions Work

  1. 1A visitor enters their email on your public status page and clicks "Subscribe".
  2. 2PingBase sends a verification email with a unique confirmation link.
  3. 3The subscriber clicks the link to verify their email address.
  4. 4Once verified, they receive notifications based on their preferences.

Only verified subscribers receive notifications. Unverified subscribers are automatically cleaned up after 7 days.

Subscriber Data

Each subscriber record contains:

Email— The subscriber's email address (required).
Phone— Optional phone number for SMS notifications (if enabled).
Verified— Whether the subscriber has confirmed their email.
Notification Preferences— Which types of notifications they want to receive.
Component Filter— Optional list of specific components to monitor.

Component-Level Subscriptions

Subscribers can optionally choose to only receive notifications for specific components. For example, a subscriber might only care about the "API Server" and "Database" components, and not want notifications about the "CDN" or "Admin Panel". When the componentIds array is empty, the subscriber receives notifications for all components.

Unsubscribing

Every notification email includes an unsubscribe link at the bottom. Clicking it immediately removes the subscriber from the list. Subscribers can also re-subscribe at any time from the public status page.

API Access

You can manage subscribers programmatically via the API:

POST /api/v1/status/:slug/subscribe
GET /api/v1/subscribers/verify?token=...
← Email Notifications
Back to Docs Home