Copy page

Getting Started

Notification Log

A Notification Log is a read-only audit entry generated automatically by the platform each time a 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.

---

How it works

1. Rule triggers — a member's activity triggers an active Notification rule.
2. Log created — the system generates a Notification Log entry in the pending status, linking to the triggering Event Log.
3. Notification compiled & sent — the system renders the message copy for the target channel and dispatches it to the designated provider.
4. Status updated — once successfully handed off to the provider, the status transitions to processed.

---

Fields

Audit information

Field	Type	Description
notificationId	UUID	Reference to the triggered Notification configuration rule
eventLogId	UUID	Reference to the triggering event record in the Event Log

Status

Field	Type	Default	Description
notificationLogStatus	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 a notification to the member:

Code
{
  "id": "019985db-c631-74b1-913d-b404a5640c8e",
  "createdAt": "2026-07-14T08:00:00.000Z",
  "updatedAt": "2026-07-14T08:00:02.000Z",
  "notificationId": "a123e456-e89b-12d3-a456-426614174000",
  "eventLogId": "b123e456-e89b-12d3-a456-426614174001",
  "notificationLogStatus": "processed",
  "status": "live"
}

---

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
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/notification_log/record — list notification logs
• GET /schema/notification_log/record/{id} — get a notification log by ID