Notification Resource

Represents a notification sent to a user, including its type, data, read status, and timestamps.

Schema

Example

{
  "id": 123,
  "type": "Comments\\NewCommentNotification",
  "data": {
    "comment_id": 456,
    "content": "Great post!",
    "__text": "A new comment was posted by user #42: \"Great post!\""
  },
  "read_at": "2025-01-01 00:00:00",
  "created_at": "2025-01-01 00:00:00"
}

Notification Types

The type field represents the type of the notification. All types have the App\Notifications\ prefix. Available types include:

• Comments\NewCommentNotification: Notifies users when a comment is added under their comment/commentable
• Payments\UserPremiumSubscriptionPurchasedNotification: Notifies users when their premium purchase is complete
• Ratings\NewRatingNotification: Notifies users when their ratable is rated (only the score is shown)
• Users\RoleAssignedNotification: Notifies users when a new permission role is assigned to their account
• Gyms\Subscriptions\GymSubscriptionCheckInNotification: Notifies users/gym owners when a check-in is done
• Gyms\Subscriptions\NewGymSubscriptionNotification: Notifies gym owners when a new subscription is purchased
• Gyms\Subscriptions\GymSubscriptionCheckOutNotification: Notifies users/gym owners when a check-out is done
• Reports\NewReportNotification: Notifies admins when a new report is created
• Chats\NewMessageNotification: Notifies users of new chat messages
• Chats\YouAreAddedToChatNotification: Notifies users when they are added to a new chat
• Training\Trainees\NewTraineeNotification: Notifies trainees/trainers when a trainee record is created
• Training\Trainees\TraineeDeliveredNotification: Notifies trainees when their record is marked as delivered
• Training\DietPlans\DietPlanCreatedNotification: Notifies trainees when a diet plan is created
• Training\DietPlans\DietPlanUpdatedNotification: Notifies trainees when a diet plan or its meals are updated
• Training\WorkoutPlans\WorkoutPlanUpdatedNotification: Notifies trainees when a workout plan is updated by the trainer
• Training\WorkoutPlans\WorkoutPlanCreatedNotification: Notifies trainees when a workout plan is created by the trainer
• Users\ReferralScoreIncreasedNotification: Notifies users when their referral score is increased
• Users\ReferralRewardReceivedNotification: Notifies users when they receive a referral reward
• Tracker\UserAteMealNotification: Notifies when a user logs a new meal
• Tracker\UserDrankWaterNotification: Notifies when a user logs drinking water (glass count included)
• Tracker\UserFinishedWorkoutNotification: Notifies when a user finishes a workout session
• Tracker\UserSharedTrackerWithYouNotification: Notifies when a user shares their tracker with another user
• Tracker\UserSleptNotification: Notifies when a user logs the time they went to sleep
• Tracker\UserStartedWorkoutNotification: Notifies when a user starts a workout session
• Tracker\UserTookSupplementNotification: Notifies when a user logs taking a supplement
• Tracker\UserTrackedWeightNotification: Notifies when a user tracks their body weight
• Tracker\UserWokeUpNotification: Notifies when a user logs the time they woke up
• Tracker\Reminders\WakeupReminderNotification: Reminds user to wakeup after 8 hours of sleep
• Tracker\Reminders\WorkoutReminderNotification: Reminds user about today's workout 1 hour after waking up
• Tracker\Reminders\SleepReminderNotification: Reminds user to sleep after 16 hours of being awake
• Tracker\Reminders\WeightReminderNotification: Reminds user to enter their weight 1 after after waking up
• Tracker\Reminders\WaterReminderNotification: Reminds user to drink some water every 3 hours
• Tracker\Reminders\MealReminderNotification: Reminds user to eat their meal
• Tracker\Reminders\SupplementReminderNotification: Reminds user to take their supplement

Data Field and __text Usage

Each notification's data object contains notification-specific fields, as well as a __text field. The __text field provides a ready-to-display, human-readable summary of the notification. Client applications should use the __text field as the default message to show to users.

• The __text value is always present and is consistent with the notification's type and context.
• Other fields in data provide structured information for advanced or custom UI needs.
• For most use cases, displaying data.__text is sufficient for a clear, user-friendly notification experience.

Example Usage

// Example: Displaying notification in a client app
const notification = /* fetched notification object */;
const message = notification.data.__text;
showNotification(message); // Display to user