Notification Subscription
Introduction¶
Our notification system sends emails to users when certain events occur in the system. Mostly, these events are tied to projects. Users have the option to receive notifications from all projects or only those they've selected. Additionally, if users choose selected projects, they can automatically subscribe to notifications for any newly created projects. This provides flexibility and ensures users stay updated with the projects most relevant to them.
Our current notification subscription page in the platform.
Flowchart of how the notification system works.
There are many events that used to trigger notifications, but currently, only five are being used. Events that are deprecated and no longer used for notifications are struck through.
- ReportCreatedEvent
- ReportRunStartedEvent
- ProjectCreatedEvent
CrawlerIncidentEventReportRunCompletedEventUserTeamInvitedEvent- TicketCommentedEvent
- CrawlerRunStartedEvent
CrawlerSummaryEventUserProjectAddedEventCrawlerSummaryPrivateEventCrawlerSummaryInternalEventCrawlerSummaryExternalEventDigestEmailTriggeredEventCrawlerExecutionTimeEvent
Here is a brief introduction to each event that is currently active.
1. ReportCreatedEvent¶
This event is triggered when a new report is created within the project. By default, all account owners are notified and receive an email whenever new reports are created in their organization. The subscription process for this event is now completed.
2. ReportRunStartedEvent¶
This event is triggered when a new report run starts. By default, all users are not notified of this event. The subscription process for this event is not yet complete.
3. ProjectCreatedEvent¶
This event is triggered when a new project is created on the platform. It's enabled by default for all users, and there is no option to opt out of this notification. The project creator, account owner, and project owner will receive a notification when a new project is created, provided the 'notify_project_owner' option is selected in the user interface.
4. TicketCommentedEvent¶
This event triggers when a new message is posted on the collaboration page or in the Jira ticket of a project. By default, all users receive this notification. In addition to subscribed users, those who have participated in the discussions will also receive email notifications.
5. CrawlerRunStartedEvent¶
This event triggers when a crawler has started running. This is off by default for all users. The subscription process for this event is not complete.