Skip to content

Module: Communications

Module: Emails

The Emails module is the central audit trail for every email sent from the platform to users. This is a critical module for compliance, customer support, and dispute resolution, as it provides a permanent, verifiable record of all outbound email communications.

Key Connections:

The Emails List View

This screen provides a platform-wide, chronological log of all emails that have been sent or are scheduled to be sent.

Column TitleDescription
Email idThe unique identifier for the email record.
Recipient emailThe email address of the recipient.
TemplateThe name of the template used to generate the email (e.g., user:welcome).
SubjectThe subject line of the email that was sent.
StatusThe delivery status of the email (e.g., SENT, FAILED).
Created atThe timestamp when the email was generated and queued for sending.

The Email Detail View

The detail view provides a complete picture of a single email, including its content and the data used to generate it.


Tab: General

This tab contains the core addressing and status information for the email.

TitleDescription
Recipient email/nameThe email address and name of the person who received the communication.
Sender email/nameThe "from" address and name that appeared on the email.
TemplateThe specific template used to build this email.
StatusThe final delivery status of the email.
Sent attempt atThe exact timestamp of the last delivery attempt.

Tab: Content

This tab shows a preview of the final, rendered HTML content of the email exactly as the user received it.


Tab: Meta

This tab provides the raw, underlying data for technical auditing and debugging.

  • Data: The JSON data payload that was used to populate the dynamic fields in the email template.

  • Meta data: Any additional metadata associated with the email.

  • Log: Technical logs generated during the email sending process.

Module: Notifications

The Notifications module manages internal, on-platform alerts shown to users within their dashboard. These are typically used for more immediate, less formal updates than email, such as confirming a recent action.

Key Connections:

  • Every Notification is linked to a specific profile.

  • They are often triggered by on-chain/off-chain events or status changes in an Investment.

The Notification List View

This screen provides a log of all internal notifications generated by the system.

Column TitleDescription
IDThe unique identifier for the notification.
StatusThe current status of the notification (e.g., UNREAD, READ).
TypeThe category of the notification (e.g., internal).
ContentA brief summary or title for the notification.
UserThe user who received the notification.

The Notification Detail View

This view shows the complete details for a single on-platform alert.

TitleDescription
UserThe user who received the notification.
StatusThe read/unread status of the notification.
TypeThe category of the notification.
ContentA brief, human-readable summary of the alert.
DataThe raw JSON data payload containing all the detailed information for the notification, often used to render a more detailed view on the frontend.