Notifications
Notifications are sent to entities to inform them of other entities' actions or other information they need access to. Notifications are separated from how they are delivered (i.e. 'email', 'Whatsapp', etc.).
Notification
webapp.notifications_notification
Notification sent to an entity.
| Field | Description | Type |
|---|---|---|
id
|
Notification ID | Number |
uuid
|
Unique notifications identifier | UUID |
title
|
Title of the notification | Text |
message
|
Message body for this notification | Text |
topic
|
Topic for this notification, such as 'note', 'credit', etc. | Text |
locale
|
Language locale the notification is written in | Text |
recipient_id
|
Entity ID for the entity receiving the notification | Numeric |
created_at
|
Datetitme the notification was created at | Date |
updated_at
|
Datetitme the notification was updated at | Date |
sender_id
|
Entity ID that sent the notification | Numeric |
reminder_id
|
Reminder ID for this notification, if one exists | Numeric |
read
|
Whether the notification has been read by the recipient or not | Boolean |
url
|
URL attached to this notification, such as sending a user to view a Note. | Text |
Channel
webapp.notifications_channel
Channel for notification delivery
| Field | Description | Type |
|---|---|---|
id
|
Channel ID | Numeric |
uuid
|
Unique channel identifier | UUID |
active
|
Whether the channel is active or not | Boolean |
verified
|
Whether the channel has been verified, such as clicking a verification link for an email channel type. | Boolean |
username
|
Username for this channel, if applicable | Text |
email
|
Email for this channel, if applicable | Text |
phone
|
Phone number for this channel, if applicable | Text |
channel_type_id
|
Channel Type ID, this defines the channel type | Numeric |
entity_id
|
Entity that owns this channel | Numeric |
Channel Type
webapp.notifications_channeltype
Channel Type, each Channel has a type, such as 'Email', or 'Whatsapp'
| Field | Description | Type |
|---|---|---|
id
|
Channel Type ID | Numeric |
name
|
Channel Type name | Text |
display_name
|
Channel Type display name | Text |
username
|
Whether this channel type has a username property | Boolean |
phone
|
Whether this channel type has a phone number property | Boolean |
email
|
Whether this channel type has an email property | Boolean |
html
|
Whether to send messages as HTTML content (true) or plain text (false) | Boolean |
Delivery
webapp.notifications_delivery
A delivery is when a notification is sent via a channel, such as via email.
| Field | Description | Type |
|---|---|---|
id
|
Delivery ID | Numeric |
uuid
|
Delivery UUID | UUID |
title
|
Title of the notification | Text |
message
|
Message body for this notification | Text |
status
|
Status, such as 'sent' | Text |
locale
|
Langauge locale for the notification | Text |
response
|
JSON response from API call to send the notification | JSON |
channel_id
|
Channel for this delivery | Numeric |
notification_id
|
Notification being sent via this Delivery object | Numeric |
created_at
|
Datetitme the Delivery was created at | Date |
updated_at
|
Datetitme the Delivery was updated at | Date |
Reminder
webapp.notifications_reminder
Reminders let entities know when they need to take a certain action, such as a loan being due
| Field | Description | Type |
|---|---|---|
id
|
Reminder ID | Numeric |
remind_ond
|
Date to remind on | Date |
reminder_type
|
Reminder type, such as 'note_due' | Text |
status
|
Status, such as 'notified', 'dismissed', etc. | Text |
entity_id
|
Entity to remind | Numeric |
note_id
|
Note this reminder is attached to, if one exists | Numeric |
created_at
|
Datetitme the Reminder was created at | Date |
updated_at
|
Datetitme the Reminder was updated at | Date |