Notification Template

Description

A NotificationTemplate represents a reusable message format used by the platform to send communications across various channels (e.g., email, SMS, push). Templates define content, layout, and metadata, and can be configured by staff depending on permissions. These templates are versioned and manageable via API for dynamic communication strategies.

Entity Properties

Note: Property definitions are based on schema references and standard usage. Actual structure should be validated with the schema source:
notificationTemplate.json

Name	Description	Type	Required
`uid`	Unique identifier of the NotificationTemplate.	`string`	Yes
`code_name`	Internal identifier for referencing the template programmatically.	`string`	Yes
`title`	Human-readable title of the template.	`string`	Yes
`description`	Brief description of the purpose of the template.	`string`	Yes
`category`	Classification of the template (e.g., "appointments", "billing").	`string`	Yes
`configurable_by_staff`	Indicates whether the template can be edited by staff users.	`boolean`	Yes
`content`	The actual content body of the notification (multi-locale/channel friendly).	`object`	Yes

Example

{
  "uid": "notif-001",
  "code_name": "appointment_reminder",
  "title": "Appointment Reminder",
  "description": "Sends a reminder to clients 24 hours before their appointment.",
  "category": "appointments",
  "configurable_by_staff": true,
  "content": {
    "en": {
      "email": {
        "subject": "Reminder: Your appointment is coming up",
        "body": "Hi {{client_name}}, your appointment is scheduled for {{appointment_time}}."
      },
      "sms": {
        "text": "Reminder: Your appointment with {{staff_name}} is at {{appointment_time}}."
      }
    }
  }
}