Getting Started
Email Notification Log
An Email Notification Log is a read-only audit entry generated automatically by the platform each time an Email Notification rule is triggered. It maps the sending attempt to the underlying Event Log and tracks whether the message is pending delivery or has been successfully processed.
Email Notification Logs are strictly read-only (GET, LIST) audit trails generated by the system. They cannot be created, modified, or deleted by administrators.
How it works
- Rule triggers — a member's activity triggers an active Email Notification rule.
- Log created — the system generates an
Email Notification Logentry in thependingstatus, linking to the triggering Event Log. - Email compiled & sent — the system renders the email subject/body (including header and footer wrappers, and merging user placeholders) and dispatches it to the mail sender.
- Status updated — once successfully handed off to the mail server, the status transitions to
processed.
Fields
Audit information
| Field | Type | Description |
|---|---|---|
emailNotificationId | UUID | Reference to the triggered Email Notification configuration rule |
eventLogId | UUID | Reference to the triggering event record in the Event Log |
Status
| Field | Type | Default | Description |
|---|---|---|---|
emailNotificationLogStatus | enum | pending | The delivery status: pending · processed |
status | enum | live | Log visibility status: draft · live · paused |
Real-world examples
🔍 Reading a Notification Log Entry
An entry showing that a challenge completion event successfully sent an email to the member:
Code
Access & permissions
| Caller | Allowed operations | Notes |
|---|---|---|
| Admin | GET · LIST | Read-only audit records |
| End user | (none) | No access |
| Guest user | (none) | No access |
Related resources
| Resource | Description |
|---|---|
| Email Notification | The active notification trigger rule |
| Event Log | The source system event log that initiated the notification |
| Member | The member recipient associated with the event and notification |
API reference
See the API Reference for full request/response schemas and interactive examples for:
GET /schema/email_notification_log/record— list email notification logsGET /schema/email_notification_log/record/{id}— get an email notification log by ID
Last modified on