Skip to content

for joining private group notif #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tenkus47 merged 1 commit into from
Aug 24, 2026
Merged

for joining private group notif #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions docs/notification-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ Routine notifications are sent only for **`PLAN`** and **`SERIES`** sessions.
| `PLAN` | Plan UUID |
| `SERIES` | Series UUID |
| `CHAT` | Chat room UUID |
| `GROUP` | Group UUID |
| `VERSE_OF_DAY` | None (`source_id` field not present) |

Plan reminder dispatches (enrollment API) always use `session_type: "PLAN"`.
Expand All @@ -70,6 +71,11 @@ Chat message pushes use `session_type: "CHAT"` plus dedicated routing fields

Verse-of-the-day pushes use `session_type: "VERSE_OF_DAY"` plus `notification_type: "VERSE_OF_DAY"`.

Group join-request pushes use `session_type: "GROUP"` with `source_id` set to the
group UUID, plus `notification_type: "JOIN_REQUEST_CREATED"` or
`"JOIN_REQUEST_DECIDED"` and the routing fields `join_request_id`, `group_id`,
and `status`.

## Default content

When no custom content is configured:
Expand Down Expand Up @@ -337,6 +343,54 @@ When the day notification uses `image_type = CUSTOM`, `image_url` points to the
}
```

### Group join request (moderators notified)

```json
{
"notification": {
"title": "Morning Sangha",
"body": "Tenzin Tib asked to join Morning Sangha"
},
"data": {
"notification_type": "JOIN_REQUEST_CREATED",
"session_type": "GROUP",
"join_request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"group_id": "f4a5b6c7-d8e9-0123-def0-234567890123",
"status": "PENDING",
"source_id": "f4a5b6c7-d8e9-0123-def0-234567890123",
"title": "Morning Sangha",
"body": "Tenzin Tib asked to join Morning Sangha",
"image_url": ""
}
}
```

### Group join request decided (requester notified)

```json
{
"notification": {
"title": "Morning Sangha",
"body": "You've joined Morning Sangha"
},
"data": {
"notification_type": "JOIN_REQUEST_DECIDED",
"session_type": "GROUP",
"join_request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"group_id": "f4a5b6c7-d8e9-0123-def0-234567890123",
"status": "APPROVED",
"source_id": "f4a5b6c7-d8e9-0123-def0-234567890123",
"title": "Morning Sangha",
"body": "You've joined Morning Sangha",
"image_url": ""
}
}
```

`status` is `APPROVED` or `REJECTED` for `JOIN_REQUEST_DECIDED`, and `PENDING`
for `JOIN_REQUEST_CREATED`. `title` and `body` are composed by the backend; the
worker forwards them unchanged.

## Chat notification delivery

Chat pushes are event-driven:
Expand Down Expand Up @@ -364,6 +418,37 @@ Configure:

Attach a dead-letter queue (DLQ) to the chat notification SQS queue for poison messages.

## Join request notification delivery

Group join-request pushes are event-driven and use their own SQS queue, separate
from the chat queue:

1. A user asks to join a private group; a Studio moderator approves or rejects it.
2. Backend enqueues `{ "event_type": "JOIN_REQUEST_CREATED" | "JOIN_REQUEST_DECIDED", "version": 1, "join_request_id": "..." }` to `JOIN_REQUEST_NOTIFICATION_SQS_QUEUE_URL`.
3. Worker consumes the event, paginates `GET /internal/join-request-notification-targets/{join_request_id}`, and sends FCM.
4. Permanently invalid tokens are deactivated via `POST /internal/push-devices/deactivate`.

**Recipients:**

| Event | Recipients |
|-------|------------|
| `JOIN_REQUEST_CREATED` | The group's moderators |
| `JOIN_REQUEST_DECIDED` | The requesting user only |

Recipients with no registered push device are counted in `total` but omitted from
`recipients`; the worker treats that as a no-op and deletes the event.

Configure:

| Variable | Purpose |
|----------|---------|
| `JOIN_REQUEST_NOTIFICATION_SQS_QUEUE_URL` | Dedicated SQS queue (backend producer, worker consumer) |
| `JOIN_REQUEST_NOTIFICATION_SQS_POLL_ENABLED` | Worker poll kill switch (`true`/`false`) |
| `JOIN_REQUEST_NOTIFICATION_SEND_CONCURRENCY` | Max concurrent FCM sends per event |
| `JOIN_REQUEST_NOTIFICATION_IDEMPOTENCY_TTL_SECONDS` | Redis TTL for `join_request_id + event_type + push_device_id` dedupe |

Attach a dead-letter queue (DLQ) to the join request notification SQS queue for poison messages.

## Preview API vs push payload

The backend preview endpoint (`GET /internal/routine-notification-targets`) returns additional server-side fields that are **not** sent to the device:
Expand Down Expand Up @@ -403,4 +488,5 @@ When the user taps a notification:
| `PLAN` | Plan detail / day view |
| `SERIES` | Series player |
| `CHAT` | Chat room / DM thread using `room_id` (`chat_kind` + optional `group_id`) |
| `GROUP` | Group screen using `group_id`; for `JOIN_REQUEST_CREATED` open the group's pending-requests view |
| `VERSE_OF_DAY` | App home / verse-of-day screen (no linked entity) |
Loading
Loading