> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt
> Use this file to discover all available pages before exploring further.
# notifications
> sift/notifications/v1/notifications.proto
## Services
*RPC methods exposed by this API.*
### NotificationService
| Method | Request | Response | Description |
| :----------------------- | :------------------------------------------------------------------ | :-------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------- |
| ListNotifications | [ListNotificationsRequest](#listnotificationsrequest) | [ListNotificationsResponse](#listnotificationsresponse) | Retrieves notifications using an optional filter. |
| BatchUpdateNotifications | [BatchUpdateNotificationsRequest](#batchupdatenotificationsrequest) | [BatchUpdateNotificationsResponse](#batchupdatenotificationsresponse) | Batch updates a list of notifications using the list of fields specified in their respective `update_mask`s. |
## Messages
*Data models used across requests/responses.*
### BatchUpdateNotificationsRequest
The request for a call to `NotificationService_BatchUpdateNotifications` to update notifications.
A maximum of 1000 notifications can be modified in a batch.
| Field | Type | Label | Description |
| :------- | :------------------------------------------------------ | :------- | :---------- |
| requests | [UpdateNotificationRequest](#updatenotificationrequest) | repeated | |
### BatchUpdateNotificationsResponse
The response of a call to `NotificationService_BatchUpdateNotifications` containing the updated notifications.
| Field | Type | Label | Description |
| :------------ | :---------------------------- | :------- | :------------------------- |
| notifications | [Notification](#notification) | repeated | The updated notifications. |
### ListNotificationsRequest
The request for a call to `NotificationService_ListNotifications` to retrieve notifications.
| Field | Type | Label | Description |
| :---------- | :----- | :---- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| page\_size | uint32 | | The maximum number of notifications to return. The service may return fewer than this value. If unspecified, at most 50 notifications will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| page\_token | string | | A page token, received from a previous `ListNotifications` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNotifications` must match the call that provided the page token. |
| filter | string | | A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `notification_id`, `created_by_user_id`, `recipient_user_id`, `created_date`, `notification_type`, and `is_read`. For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/notifications#notification). Optional. |
### ListNotificationsResponse
The response of a call to `NotificationService_ListNotifications`.
| Field | Type | Label | Description |
| :---------------- | :---------------------------- | :------- | :---------- |
| notifications | [Notification](#notification) | repeated | |
| next\_page\_token | string | | |
### Notification
| Field | Type | Label | Description |
| :--------------------- | :------------------------------------ | :---- | :---------- |
| notification\_id | string | | |
| created\_date | google.protobuf.Timestamp | | |
| modified\_date | google.protobuf.Timestamp | | |
| created\_by\_user\_id | string | | |
| modified\_by\_user\_id | string | | |
| organization\_id | string | | |
| recipient\_user\_id | string | | |
| is\_read | bool | | |
| full\_link | string | | |
| notification\_type | [NotificationKind](#notificationkind) | | |
| contents | string | | |
| entity\_id | string | | |
### UpdateNotificationRequest
| Field | Type | Label | Description |
| :----------- | :------------------------------------------------------ | :---- | :------------------------------------------------------------------------------------------------------------------------------------------ |
| notification | [Notification](#notification) | | The notification to update. The notification's `notification_id` field is used to identify the notification to update and must be provided. |
| update\_mask | [google.protobuf.FieldMask](#google-protobuf-fieldmask) | | The list of fields to be updated. Currently, the only field that can be updated is `is_read`. |
## Enums
*Allowed constant values used in message fields.*
### NotificationKind
| Name | Number | Description |
| :----------------------------------------------------- | :----- | :---------- |
| NOTIFICATION\_KIND\_UNSPECIFIED | 0 | |
| NOTIFICATION\_KIND\_TEXT | 1 | |
| NOTIFICATION\_KIND\_ANNOTATION\_ASSIGNED | 2 | |
| NOTIFICATION\_KIND\_MENTIONED\_IN\_ANNOTATION\_COMMENT | 3 | |
| NOTIFICATION\_KIND\_CONDITION\_TRIGGERED | 4 | |
| NOTIFICATION\_KIND\_ANNOTATION\_STATE\_CHANGED | 5 | |
| NOTIFICATION\_KIND\_REPORT\_READY | 6 | |
| NOTIFICATION\_KIND\_DATA\_EXPORT\_READY | 7 | |
| NOTIFICATION\_KIND\_MENTIONED\_IN\_COMMENT | 8 | |