JSON File Store

The simplest subscriber store — perfect for local development and small lists.

Public repos

In a public repo, subscribers.json must be committed for GitHub Actions to read it, which exposes subscriber emails. Use the GitHub Gist store instead — it keeps the same JSON format in a private Gist.

Setup

export SUBSCRIBER_STORE=json

Configuration

Variable	Default	Description
SUBSCRIBERS_JSON_PATH	./subscribers.json	Path to subscriber data
EMAIL_LOG_JSON_PATH	./email-log.json	Path to email send log

File format

Create a subscribers.json file with an array of subscriber objects:

[
  {
    "email": "alice@example.com",
    "name": "Alice",
    "productIds": ["my-app", "other-app"]
  },
  {
    "email": "bob@example.com",
    "productIds": ["my-app"]
  }
]

Each subscriber has:

Field	Required	Description
email	Yes	Subscriber email address
name	No	Display name
productIds	Yes	Array of product IDs they’re subscribed to

When using audiences, use compound keys in productIds:

[
  {
    "email": "alice@example.com",
    "productIds": ["my-app:beta"]
  },
  {
    "email": "carol@example.com",
    "productIds": ["my-app:enterprise", "other-app"]
  }
]

Email logging

Sent emails are logged to email-log.json (or your configured path). This is a simple append-only JSON array.

Example

See subscribers.example.json in the repo.