Skip to content

Commit 2e469dc

Browse files
committed
Add topicName information
1 parent f586af9 commit 2e469dc

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

functions/src/notifications/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@ The notification feature is responsible for sending notifications to users based
66

77
## Features
88

9-
- **Topic-Based Notifications**: Users receive notifications based on topics they are interested in.
10-
- It can be either a Bill Topic or an Org Topic
9+
- **Topic-Based Notifications**: Users receive notifications based on topics they are subscribed to.
10+
- Each user has a list of topics created when subscribing to a Bill, User, or Organization.
11+
- Topics can be categorized as either Bill Topics or Organization Topics:
12+
- `bill-[courtId]-[billId]`: Triggers when a subscribed Bill has a history update or when testimony is posted on the Bill.
13+
- `testimony-[userId]`: Triggers when a subscribed User or Organization posts testimony.
1114
- **Notification Events**
1215
- A BillHistoryNotificationEvent is created when a subscribed Bill has an updated history
1316
- A TestimonySubmissionNotificationEvent is created when a subscribed Bill has testimony published and when a Organization/User publishes testimony

0 commit comments

Comments
 (0)