subscriptions.yaml

# Opt-in feed-health alerts. Each subscriber gets a digest of only the agencies
# they follow and the alert kinds they chose, and only when one needs attention.
# An all-clear sends nothing.
#
# Consent is a hard gate: a subscriber is emailed only when verified is true. New
# addresses start unverified and stay silent until the address is confirmed
# (double opt-in). See docs/decisions/0004-opt-in-alerts.md.
#
# The addresses here are examples; they are unverified, so nothing is sent. The
# digest is built and sent by the daily run (scorecard notify).
#
# Fields per subscriber:
#   email      where the digest goes (required)
#   agencies   list of agency ids to follow
#   all: true  follow every tracked agency (e.g. a statewide program liaison)
#   kinds      which alerts to receive, as a list drawn from: expiry,
#              lapse_risk, regression, export_change, anomaly. Omit for every
#              kind. "expiry" warns before a feed expires (the expiry opt-in);
#              "export_change" warns when the export's structure changed
#              (a route dropped, stops moved) even though nothing was invalid,
#              so the grade didn't move to flag it.
#   rollups    list of rollup (cohort) ids to also receive a weekly portfolio
#              digest for. A liaison opts into a cohort rollup here; the digest
#              summarizes week-over-week movement across that whole cohort. Same
#              verified gate as alerts: unverified is never sent. Omit for none.
#   verified   true only after the address is confirmed; unverified is never sent.
#   webhook_url  an https:// incoming-webhook URL (Slack, Microsoft Teams, or a
#              generic endpoint) that also gets this subscriber's digest as a
#              JSON POST ({"text": "..."}). Optional and additive to email; a
#              program liaison can set both, or a webhook alone.
subscribers:
  - email: liaison@example.org
    all: true
    kinds:
      - expiry
    verified: false
  # A statewide liaison who also wants the weekly cohort rollup (still unverified,
  # so nothing is sent until the address is confirmed).
  # - email: portfolio-liaison@example.org
  #   all: true
  #   rollups:
  #     - all
  #   verified: false