Fyren Docs
Features

Notifications

Email subscribers, subscriber groups, and email provider configuration.

Fyren notifies your subscribers by email when incidents, maintenance, or component status changes occur. Subscribers can filter by component, and groups make it easy to manage notification preferences for sets of users.

Email Subscribers

Anyone can subscribe to your status page by entering their email address on the public status page. The subscription flow:

  1. User submits their email
  2. A verification email is sent with a confirmation link
  3. User clicks the link to confirm — they're now subscribed
  4. Each notification email includes a one-click unsubscribe link

Component Filtering

Subscribers can choose which components they care about. When componentIds is set, the subscriber only receives notifications related to those specific components. When set to null, they receive all notifications.

Notification Preferences

Each subscriber has toggles for the types of notifications they receive:

PreferenceDescription
notifyOnIncidentReceive incident created/updated/resolved emails
notifyOnMaintenanceReceive maintenance scheduled/started/completed emails

Subscriber Groups

Groups let you organize subscribers and apply component filtering at the group level.

  • Each group has a name, description, and optional componentIds filter
  • When a subscriber belongs to a group, the group's component filter takes precedence
  • Groups cannot be deleted while they still have members

Manage groups via the admin dashboard or the API:

GET    /api/v1/admin/subscriber-groups
POST   /api/v1/admin/subscriber-groups
PUT    /api/v1/admin/subscriber-groups/:id
DELETE /api/v1/admin/subscriber-groups/:id
GET    /api/v1/admin/subscriber-groups/:id/members

Notification Triggers

The following events trigger notifications to eligible subscribers:

EventDescription
incident.createdA new incident is reported
incident.updatedAn incident status or message is updated
incident.resolvedAn incident is marked as resolved
maintenance.scheduledA new maintenance window is created
maintenance.startedMaintenance begins
maintenance.completedMaintenance ends
component.status_changedA component's status changes

Email Providers

Fyren supports three email providers, configured per-organization. Set the provider and credentials via the admin dashboard under Settings.

SMTP

SettingDescription
hostSMTP server hostname
portSMTP server port (default: 587)
userSMTP username
passwordSMTP password
secureUse TLS connection

SendGrid

SettingDescription
apiKeyYour SendGrid API key

Amazon SES

SettingDescription
regionAWS region (e.g., us-east-1)
accessKeyIdAWS access key ID
secretAccessKeyAWS secret access key

Email provider credentials are encrypted at rest using AES-GCM. See Configuration for the ENCRYPTION_KEY and email environment variables.

A console provider is available for development — it logs emails to stdout instead of sending them.

Delivery Tracking

Every notification attempt is logged in the notification log with:

  • Event type and entity reference
  • Recipient and channel (email or webhook)
  • Delivery status: pending, sent, or failed
  • Error details for failed deliveries

Failed email deliveries are retried automatically with exponential backoff (up to 3 attempts).

RSS Feed

An RSS 2.0 feed of recent incidents and maintenance events is available at:

GET /api/v1/status/rss

Users can subscribe to this feed in any RSS reader for passive status updates without needing to provide an email address.

See Also

  • Webhooks — Slack, Discord, Teams, and generic webhook integrations
  • Configuration — Email and encryption environment variables

On this page