English
User Guide
Subscribers

Subscribers

Manage users who receive notifications about status updates.

Subscribers List

Overview

Subscribers are users who want to be notified about:

  • New incidents
  • Incident updates and resolutions
  • Scheduled maintenances
  • Component status changes

Subscription Channels

ChannelDescription
EmailEmail notifications
SMSText message alerts
WebhookHTTP POST to custom URL
RSS/AtomFeed subscriptions (self-service)

How Users Subscribe

Public Subscription Form

Users can subscribe from your status page:

  1. They click "Subscribe" on your status page
  2. Choose their notification method
  3. Enter contact information
  4. Select components to follow (optional)
  5. Confirm subscription

Admin-Created Subscriptions

Create subscriptions from the dashboard:

  1. Navigate to Dashboard > Subscribers
  2. Click "Add Subscriber"
  3. Configure:
FieldDescription
TypeEmail, SMS, or Webhook
ContactEmail/phone/URL
ComponentsSpecific components (or all)
EventsWhich events to notify
  1. Click "Create"

Email Subscribers

Creating

curl -X POST http://localhost:3000/api/v1/subscribers \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "email",
    "email": "user@example.com",
    "componentIds": [],
    "events": ["incident.created", "incident.resolved"]
  }'

Email Branding

Customize notification emails:

  1. Navigate to Settings > Email Branding
  2. Configure:
    • Logo
    • Colors
    • Header/footer text
    • Custom CSS

Email Preview

Test email appearance:

  1. Go to Settings > Email Branding
  2. Click "Preview"
  3. Select template type
  4. View rendered email

SMS Subscribers

SMS requires Twilio configuration. See Notifications.

Creating

curl -X POST http://localhost:3000/api/v1/subscribers \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "sms",
    "phone": "+1234567890",
    "componentIds": []
  }'

SMS Format

SMS messages are concise:

[ReliaPulse] Major Incident: API is down.
View: https://status.example.com/incidents/123

Webhook Subscribers

Send notifications to custom endpoints:

Creating

curl -X POST http://localhost:3000/api/v1/subscribers \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "webhook",
    "webhookUrl": "https://example.com/webhook",
    "webhookSecret": "optional-secret"
  }'

Webhook Payload

{
  "event": "incident.created",
  "timestamp": "2026-01-22T10:30:00Z",
  "incident": {
    "id": "inc_123",
    "title": "API Response Delays",
    "status": "investigating",
    "impact": "major",
    "components": ["API"]
  }
}

Webhook Security

If webhookSecret is set:

  • Signature included in X-Signature-256 header
  • Calculated as HMAC-SHA256 of payload

Verify in your endpoint:

const crypto = require('crypto');
const signature = crypto
  .createHmac('sha256', secret)
  .update(body)
  .digest('hex');
 
if (signature !== request.headers['x-signature-256']) {
  throw new Error('Invalid signature');
}

CSV Import

Bulk import subscribers:

Preparing the CSV

type,email,phone,componentIds
email,user1@example.com,,
email,user2@example.com,,comp-1
sms,,+1234567890,
sms,,+0987654321,comp-1;comp-2

Importing

  1. Navigate to Dashboard > Subscribers
  2. Click "Import"
  3. Upload CSV file
  4. Review preview
  5. Confirm import

Import Options

OptionDescription
Skip DuplicatesIgnore existing emails/phones
Update DuplicatesUpdate component preferences

RSS/Atom/JSON Feeds

Self-service feeds require no subscription:

FormatURL
RSS/api/v1/public/status/{slug}/feed?format=rss
Atom/api/v1/public/status/{slug}/feed?format=atom
JSON/api/v1/public/status/{slug}/feed?format=json

Users can add these to their feed readers.

Managing Subscribers

Viewing Subscribers

  1. Navigate to Dashboard > Subscribers
  2. Filter by type or search
  3. View subscriber details

Editing Preferences

  1. Click on a subscriber
  2. Modify:
    • Component subscriptions
    • Event preferences
    • Contact information
  3. Save changes

Unsubscribing

User self-service:

  • Click unsubscribe link in email
  • Text STOP for SMS

Admin removal:

  1. Find the subscriber
  2. Click "Delete"
  3. Confirm

Component Subscriptions

Subscribers can follow specific components:

All Components

Leave component selection empty to receive all notifications.

Specific Components

Select specific components:

  • Only notified about those components
  • New components not automatically added

Component Groups

Subscribe to a parent component to receive notifications for all children.

Event Preferences

Control which events trigger notifications:

EventDescription
incident.createdNew incident
incident.updatedStatus/content changed
incident.resolvedIncident resolved
maintenance.scheduledMaintenance planned
maintenance.startedMaintenance begins
maintenance.completedMaintenance ends

API Access

List Subscribers

curl http://localhost:3000/api/v1/subscribers \
  -H "Authorization: Bearer sk_live_xxx"

Create Subscriber

curl -X POST http://localhost:3000/api/v1/subscribers \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "email",
    "email": "user@example.com"
  }'

Delete Subscriber

curl -X DELETE http://localhost:3000/api/v1/subscribers/{id} \
  -H "Authorization: Bearer sk_live_xxx"

Import Subscribers

curl -X POST http://localhost:3000/api/v1/subscribers/import \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@subscribers.csv"

Best Practices

Privacy

  • Collect only necessary information
  • Provide easy unsubscribe
  • Comply with email regulations (CAN-SPAM, GDPR)

Communication

  • Don't over-notify
  • Keep messages relevant
  • Include essential information only

Maintenance

  • Clean up bounced emails
  • Remove inactive subscribers
  • Review webhook endpoints

Related Documentation