sergei_t/WellNuo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
WellNuo/docs/NOTIFICATION_API_SPECIFICATION.md
Sergei 1dd7eb8289 Remove hardcoded credentials and use environment variables 
- Remove hardcoded database credentials from all scripts
- Remove hardcoded Legacy API tokens from backend scripts
- Remove hardcoded MQTT credentials from mqtt-test.js
- Update backend/.env.example with DB_HOST, DB_USER, DB_PASSWORD, DB_NAME
- Update backend/.env.example with LEGACY_API_TOKEN and MQTT credentials
- Add dotenv config to all scripts requiring credentials
- Create comprehensive documentation:
  - scripts/README.md - Root scripts usage
  - backend/scripts/README.md - Backend scripts documentation
  - MQTT_TESTING.md - MQTT testing guide
  - SECURITY_CREDENTIALS_CLEANUP.md - Security changes summary

All scripts now read credentials from backend/.env instead of hardcoded values.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2026-01-29 12:13:32 -08:00

2.6 KiB
Raw Blame History

WellNuo Notification API Specification

Version: 1.0 Date: 2026-01-27

Overview

WellNuo needs API endpoints to send notifications through 3 channels:

  1. Email — Alert notifications
  2. SMS — Emergency alerts
  3. Voice — Emergency phone calls

Authentication

API Key in Authorization header:

Authorization: Bearer {API_KEY}

1. Email API

Endpoint

POST /api/v1/notify/email

Request

{
  "to": "user@example.com",
  "subject": "WellNuo Alert: Ferdinand",
  "body": {
    "html": "<html><body><h1>Alert</h1><p>Ferdinand has not moved for 7 hours.</p></body></html>",
    "text": "Alert: Ferdinand has not moved for 7 hours."
  }
}

Fields

Field Type Required Description
to string Yes Recipient email
subject string Yes Email subject
body.html string Yes HTML content
body.text string Yes Plain text fallback

Response

{
  "success": true,
  "message_id": "msg_abc123"
}

2. SMS API

Endpoint

POST /api/v1/notify/sms

Request

{
  "to": "+14155552671",
  "message": "WellNuo Alert: Ferdinand has not moved for 7 hours. Check app for details."
}

Fields

Field Type Required Description
to string Yes Phone number (E.164 format: +1234567890)
message string Yes SMS text (max 1600 characters)

Response

{
  "success": true,
  "message_id": "msg_xyz789"
}

3. Voice API

Endpoint

POST /api/v1/notify/voice

Request

{
  "to": "+14155552671",
  "message": "This is an urgent alert from WellNuo. Ferdinand has not moved for 7 hours. Please check on them immediately."
}

Fields

Field Type Required Description
to string Yes Phone number (E.164 format)
message string Yes Text that will be spoken to the user

Response

{
  "success": true,
  "call_id": "call_abc123"
}

Error Response

All endpoints return errors in this format:

{
  "success": false,
  "error": {
    "code": "INVALID_PHONE",
    "message": "Phone number format is invalid"
  }
}

Error Codes

Code HTTP Description
VALIDATION_ERROR 400 Invalid request data
INVALID_PHONE 400 Phone number format wrong
INVALID_EMAIL 400 Email format wrong
UNAUTHORIZED 401 Invalid API key
RATE_LIMITED 429 Too many requests
SERVER_ERROR 500 Internal error