Domains / Customer Management/ API Endpoint

Notification API

REST API for managing notification preferences, delivery channels, and sending transactional notifications to tenant users.

API Endpoint Application draft

Notification API handles delivery of transactional notifications (email, in-app, webhook) to tenant users. It supports template management, delivery preferences, and notification history.

Endpoints

  • POST /api/v1/notifications/send — Send notification
  • GET /api/v1/notifications/preferences — Get user notification preferences
  • PUT /api/v1/notifications/preferences — Update notification preferences
  • GET /api/v1/notifications/history — List notification history

Relationships

◇ Composes outgoing 1
Target Element Element Type
Tenant Admin Portal Software Subsystem
◇ Part of incoming 2
Source Element Element Type
Notification Service Software Subsystem
Tenant Admin Portal Software Subsystem
→ Served by incoming 32
Source Element Element Type
Anomaly Detected Domain Event
Audit Alert Triggered Domain Event
Bulk Import Completed Domain Event
Capacity Limit Approaching Domain Event
Compliance Report Generated Domain Event
Connector Error Detected Domain Event
Contact Created Domain Event
Data Erasure Completed Domain Event
Data Pipeline Failed Domain Event
Export Completed Domain Event
Health Score Changed Domain Event
Incident Declared Domain Event
Insight Shared Domain Event
Notification Bounced Domain Event
Onboarding Completed Domain Event
Onboarding Started Domain Event
Payment Method Updated Domain Event
Payment Refunded Domain Event
Permission Policy Changed Domain Event
Privacy Request Received Domain Event
Report Generated Domain Event
SLO Breach Detected Domain Event
Subscription Cancelled Domain Event
Tenant Reactivated Domain Event
Tenant Suspended Domain Event
User Deactivated Domain Event
User Invited Domain Event
User Provisioned Domain Event
User Role Changed Domain Event
Webhook Delivery Failed Domain Event
Webhook Failed Domain Event
Workflow Executed Domain Event

Architecture Context

Diagrams

Properties

Type API Endpoint
Layer Application
Domain Customer Management
Status draft
Owner Platform Team

Additional Metadata

Protocol REST/JSON
Archimate Type application-interface
Togaf Type Information System Service

Meta Model

Business
Organization
Application current
Technology

Actions