CyferWall Engage Backend Documentation¶

Welcome to the comprehensive documentation for the CyferWall Engage Backend - a robust Node.js/TypeScript API service powering customer engagement and support operations.

🚀 Quick Start¶

Development Setup¶

# Clone and install dependencies
npm install

# Setup environment
cp .env.example .env
# Configure your environment variables

# Initialize database
npm run postinstall
npx prisma db push

# Start development server
npm run dev

Production Deployment¶

# Build the application
npm run build

# Start production server
npm start

🔗 API Base URL: https://api.cyferwall.com/api/v1
🏃 Development: http://localhost:3000/api/v1

📋 System Overview¶

The Engage Backend provides:

• 🎫 Support Case Management - Complete ticketing system
• 📧 Notification System - Multi-channel notifications (Email, SMS, Webhook)
• 👤 User Authentication - JWT-based auth with social providers
• 📊 Health Monitoring - System health and metrics endpoints
• 🔐 Security - Rate limiting, CORS, input validation
• 📈 Observability - DataDog tracing and Winston logging

Architecture¶

graph TB
    A[Client Applications] --> B[Express.js API Server]
    B --> C[Authentication Middleware]
    C --> D[Route Controllers]
    D --> E[Business Logic Services]
    E --> F[Database Layer]
    E --> G[Notification System]
    E --> H[External Services]

    F --> I[(PostgreSQL)]
    G --> J[Email Provider]
    G --> K[SMS Provider]
    H --> L[Apple SignIn]
    H --> M[Google Auth]

🛣️ API Routes¶

Core System Routes¶

Support Management¶

🔧 Core Components¶

1. Health & Monitoring¶

• Heartbeat: Database connectivity check
• Metrics: Prisma ORM performance metrics
• Logging: Structured logging with Winston
• Tracing: DataDog APM integration

2. Support System¶

• Multi-tier support case management
• Automated escalation workflows
• Customer and staff notifications
• Case status tracking

3. Notification Engine¶

• Template-based notifications
• Multi-channel delivery (Email/SMS/Webhook)
• Retry logic and failure handling
• Template validation and testing

4. Security & Auth¶

• JWT token authentication
• Social provider integration (Google, Apple)
• Request validation with Zod schemas
• Rate limiting and CORS protection

🏁 Getting Started¶

Choose your path:

🔧 Developers¶

Start with Quick Setup for local development environment setup.

🎫 Support Integration¶

Jump to Support APIs for ticketing system integration.

📧 Notifications¶

Explore Notification System for email/SMS automation.

🚀 Deployment¶

Check Deployment Guide for production deployment.

🛠️ Troubleshooting¶

Visit Common Issues for quick problem resolution.

📖 Documentation Sections¶

• Getting Started - Environment setup and first steps
• API Reference - Complete endpoint documentation
• Support System - Case management workflows
• Notification System - Email/SMS automation
• Authentication - User auth and security
• Database - Data models and migrations
• Deployment - Production deployment guide
• Troubleshooting - Common issues and solutions

🔗 Quick Links¶

• 🌐 Live API Documentation
• 📊 System Dashboard
• 🐛 Bug Reports
• 💬 Support Chat

Made with ❤️ by the CyferWall Team

🚀 Quick Start¶

Get up and running with our notification system in under 5 minutes:

import { notifications } from '@/util/notifications/ultra-simple'

// Send a notification email
await notifications.email('case-received-customer', 'user@example.com', {
  caseNumber: 'CW-2025-001',
  customerName: 'John Doe'
})

// Send SMS
await notifications.sms('+1234567890', 'Your case has been updated')

// Test a template
const test = await notifications.test('case-escalated', { caseNumber: 'CW-2025-001' })

📋 What's Included¶

🔔 Notification System¶

• Template-driven notifications with Handlebars rendering
• Multi-channel support (Email, SMS, Webhooks)
• Automatic error handling and logging
• Easy testing and debugging tools

🎫 Support APIs¶

• Customer-facing APIs for case creation, status checks, escalation
• Internal staff APIs for case management and operations
• Integrated notifications for all case lifecycle events
• Real-time status tracking and updates

📝 Template Management¶

• Organized template structure by category and audience
• Dynamic content rendering with Handlebars helpers
• Variable validation and type checking
• Easy template testing and preview

🏗️ Architecture Overview¶

graph TB
    A[Support API Endpoints] --> B[Case Controllers]
    B --> C[Notification Service]
    C --> D[Template Manager]
    D --> E[HTML Templates]
    C --> F[Email Provider]
    C --> G[SMS Provider]
    C --> H[Webhook Service]

    I[Customer] --> A
    J[Support Staff] --> A
    K[External Systems] --> A

📚 Documentation Sections¶

🔧 Key Features¶

Ultra-Simple API¶

// Before (complex)
const service = new NotificationService()
const result = await service.sendEmail({
  templateId: 'case-received',
  to: 'user@example.com',
  data: { caseNumber: '123' }
})

// After (ultra-simple)
const result = await notifications.email('case-received', 'user@example.com', { caseNumber: '123' })

Robust Template System¶

• Category organization: customer, internal, support, operations
• Variable validation: Required vs optional variables with type checking
• Helper functions: Date formatting, calculations, conditionals
• Error handling: Clear error messages and fallback options

Complete Integration¶

• ✅ Case creation notifications
• ✅ Status update notifications
• ✅ Escalation notifications
• ✅ Cancellation notifications
• ✅ Internal staff notifications
• ✅ Operations team notifications

🎯 Quick Navigation¶

📞 Support¶

For internal support and questions:

• Slack: #engage-backend-support
• Email: engineering@cyferwall.com
• Issues: Internal GitHub Issues

This documentation is automatically updated with each deployment. Last updated: {{ "now" | date("YYYY-MM-DD HH:mm") }}