Skip to content
Chatto v0.5.0

NotificationService

Chatto exposes this service below /api/connect.

Shared message and enum definitions are documented in Shared Types And Enums.

Reads, marks read, and deletes notifications for the authenticated viewer.

Gets one exact visible occurrence. Message-derived occurrences require current room membership. Occurrences also require message.read or a matching thread relationship with message.read-interactions. Returns NOT_FOUND when the occurrence is absent, deleted, expired, or no longer visible to the authenticated viewer. Returns UNIMPLEMENTED when this server cannot validate its signal kind.

POST /api/connect/chatto.api.v1.NotificationService/GetNotificationOccurrence

Request one exact notification occurrence by stable ID.

FieldTypeDescription
notification_idstringRequired stable occurrence ID.

One exact notification occurrence.

FieldTypeDescription
occurrenceNotificationOccurrenceVisible occurrence. Absence is reported as NOT_FOUND.

Gets an explicit bounded set of visible occurrences. Missing or inaccessible IDs are omitted and duplicate IDs are de-duplicated. Returns UNIMPLEMENTED rather than partially answering when this server cannot validate one requested signal kind.

POST /api/connect/chatto.api.v1.NotificationService/BatchGetNotificationOccurrences

Input: BatchGetNotificationOccurrencesRequest

Section titled “Input: BatchGetNotificationOccurrencesRequest”

Request an explicit bounded set of notification occurrences.

FieldTypeDescription
notification_idsrepeated stringStable occurrence IDs. Unknown, deleted, and currently invisible IDs are omitted. Repeated IDs are de-duplicated in first-seen request order.

Result: BatchGetNotificationOccurrencesResponse

Section titled “Result: BatchGetNotificationOccurrencesResponse”

Exact visible notification occurrences requested by stable ID.

FieldTypeDescription
occurrencesrepeated NotificationOccurrenceFound occurrences in first-seen request order.

Lists exact Notifications 2.0 occurrences. Clients may derive temporary presentation groups without changing occurrence identity or counts. Message-derived occurrences require current room membership. Occurrences also require message.read or a matching thread relationship with message.read-interactions. Returns UNIMPLEMENTED rather than silently omitting an occurrence whose signal kind this server version cannot validate and assemble.

POST /api/connect/chatto.api.v1.NotificationService/ListNotificationOccurrences

Request for one page of notification occurrences.

FieldTypeDescription
pagePageRequestDefaults to 50 results when absent or limit is zero. Maximum: 100.

Result: ListNotificationOccurrencesResponse

Section titled “Result: ListNotificationOccurrencesResponse”

One page of exact notification occurrences.

FieldTypeDescription
occurrencesrepeated NotificationOccurrenceOccurrences newest activity first.
pagePageInfoPage metadata.
unread_countint32Total unread occurrence count, independent of presentation grouping.
next_expiry_atgoogle.protobuf.TimestampEarliest expiry in the complete list, including occurrences outside this page. Clients refresh authoritative notification state at this boundary.
room_unread_countsrepeated NotificationRoomUnreadCountComplete unread-occurrence counts by target room. This is independent of the bounded page so room indicators remain authoritative.
important_unread_countint32Exact unread occurrences with Important attention.

Marks one occurrence read. Repeating the call is safe. Returns UNIMPLEMENTED when this server cannot validate the occurrence signal kind.

POST /api/connect/chatto.api.v1.NotificationService/MarkNotificationRead

Request to mark one notification occurrence read.

FieldTypeDescription
notification_idstringRequired stable occurrence ID.

Notification occurrence after marking it read.

FieldTypeDescription
occurrenceNotificationOccurrenceUpdated occurrence.

Permanently deletes one occurrence while retaining its anti-recreation tombstone through the original expiry. Repeating the call is safe. Returns UNIMPLEMENTED when this server cannot validate the occurrence signal kind.

POST /api/connect/chatto.api.v1.NotificationService/DeleteNotificationOccurrence

Input: DeleteNotificationOccurrenceRequest

Section titled “Input: DeleteNotificationOccurrenceRequest”

Request permanent deletion of one notification occurrence.

FieldTypeDescription
notification_idstringRequired stable occurrence ID.

Result: DeleteNotificationOccurrenceResponse

Section titled “Result: DeleteNotificationOccurrenceResponse”

Result of deleting one notification occurrence.

FieldTypeDescription
deletedboolTrue when this call replaced a visible occurrence with a deletion tombstone. False when the occurrence was already absent or deleted.

Permanently deletes an exact set of occurrences. Repeating the call is safe because later activity receives different occurrence IDs. Returns UNIMPLEMENTED rather than partially deleting a signal kind this server cannot validate.

POST /api/connect/chatto.api.v1.NotificationService/BatchDeleteNotificationOccurrences

Input: BatchDeleteNotificationOccurrencesRequest

Section titled “Input: BatchDeleteNotificationOccurrencesRequest”

Request permanent deletion of an explicit bounded set of occurrences.

FieldTypeDescription
notification_idsrepeated stringStable occurrence IDs to delete. Duplicates and already absent IDs are ignored. The server accepts at most 100 IDs.

Result: BatchDeleteNotificationOccurrencesResponse

Section titled “Result: BatchDeleteNotificationOccurrencesResponse”

Result of deleting exact notification occurrences.

FieldTypeDescription
deleted_countint32Number of visible occurrences replaced by deletion tombstones.

Permanently deletes every visible occurrence current at the server’s authoritative mutation boundary. Callers must not retry this mutation automatically because later activity may arrive after that boundary. Returns UNIMPLEMENTED rather than partially deleting a signal kind this server cannot validate.

POST /api/connect/chatto.api.v1.NotificationService/DeleteAllNotificationOccurrences

Input: DeleteAllNotificationOccurrencesRequest

Section titled “Input: DeleteAllNotificationOccurrencesRequest”

Request permanent deletion of every currently visible notification occurrence.

Result: DeleteAllNotificationOccurrencesResponse

Section titled “Result: DeleteAllNotificationOccurrencesResponse”

Result of deleting every currently visible notification occurrence.

FieldTypeDescription
deleted_countint32Number of visible occurrences replaced by deletion tombstones.