Skip to content

Notification System Glossary

  • pending notification: These are all the notifications that are currently queued (in Redis queue), but not sent.
  • notification type: the type of notification (e.g. email, SMS, postcard, etc)
  • notifiable: any entity that can be the recipient of a notification
  • recipient: equivalent to notifiable
  • notification: The actual message that's sent out
  • notification channel: Specifies the mechanism by which we sent-out notifications, e.g. MailChannel
  • notification log: Log of all pending, sent, and failed notifications used for frequency limit checks
  • notification queue: Refers to Redis queue (visit /admin/horizon to view the status of the queue)
  • notify: the act of sending a notification to a recipient; when a recipient is notified the notification it's not sent immediately, but queued to be processed at a later time.
  • delay: The interval between the time we queue the notification & the time it's sent. This delay is a magnitude of seconds, unless it's explicitly set to a higher number on the notification.
  • sender: The sender of the notification, valid for email notifications. Each sender has an email address, name, reply-to address, etc.
  • notification chain: Multiple notifications that should be sent one after another. Each notification in a chain has a certain pre-condition & a time to be sent.
  • Frequency limit: Specifies the minimum interval of time before another notification of the same type can be sent.
  • Trigger mode: Defines the condition by which the notification is triggered, either "React" or "Cron".
  • Trigger Conditions: A set of rules with "and" or "or" statements that must be valid for the notification to be sent.
  • Testing Instance: ID of the testing instance from the admin testing panel, currently non-functional.
  • Disabled: Indicates that the notification is currently turned off, with an explanation for documentation.
  • Cron Command: Links to the console command responsible for triggering the notification if it is triggered by "cron".
  • Attachments: List of files that are attached to the notification.