Skip to content

Checking access...

notification-service API

Standalone transactional email microservice for Hello World DAO and FounderyOS. Dispatches dual-branded emails via Resend across 14 template types with a CAN-SPAM–compliant digest flow.

Service: notification-service · Port 3100 · AX42-U k3s (founderyos namespace) Epic: PLATFORM-002 (stable)

For the full reference including all endpoints, schemas, sequence diagrams, template catalog, env vars, and error table, see the root API reference at api/notification-service.md.

Quick Reference

Endpoints

MethodPathAuthPurpose
POST/api/v1/sendBearer service tokenDispatch a single email
GET/api/v1/healthPublicLiveness probe

Authentication

http
Authorization: Bearer <TOKEN_NOTIFICATION_SERVICE>

Token source: platform/service-tokens k8s Secret, key TOKEN_NOTIFICATION_SERVICE. Callers read it from NOTIFICATION_SERVICE_TOKEN in their own environment.

Fail-closed: SERVICE_TOKEN unset at boot → 503 on all requests.

Request Shape

jsonc
{
  "type": "password-reset",       // one of 14 template types
  "to": "user@example.com",
  "domain": "helloworlddao.com",  // or "founderyos.dev"
  "data": { /* template-specific fields */ },
  "attachments": [ ... ]          // optional, max 10, 25 MiB each
}

Success Response

jsonc
{
  "id": "re_...",
  "status": "sent",
  "stubbed": false,
  "request_id": "aae9048a-31af-4f42-9758-48de4a0fbd8f"
}

14 Template Types

TypeBrand(s)Category
welcomeDAO + FOSTransactional
password-resetDAO + FOSTransactional
password-changedDAO + FOSTransactional
verificationDAO + FOSTransactional
invitationDAO + FOSTransactional
membership-confirmDAO onlyTransactional
renewal-receiptDAO onlyTransactional
payment-receiptDAO + FOSTransactional
refund-confirmationDAO + FOSTransactional
treasury-milestoneDAO onlyTransactional
e2e-test-resultsDAO + FOSTransactional
parental-consentDAO + FOSTransactional
event-reminderDAO + FOSTransactional + ICS attachment
notification-digestDAO + FOSOpt-in (unsubscribe required)

Caller Env Vars

VarNotes
NOTIFICATION_SERVICE_URLIn-cluster: http://notification-service.founderyos.svc.cluster.local:3100 · Via gateway: https://apis.helloworlddao.com/notify
NOTIFICATION_SERVICE_TOKENMatches TOKEN_NOTIFICATION_SERVICE in platform/service-tokens

Hello World Co-Op DAO