notifications

Protocol buffer definition for notifications

sift/notifications/v1/notifications.proto

BatchUpdateNotificationsRequest

The request for a call to NotificationService_BatchUpdateNotifications to update notifications. A maximum of 1000 notifications can be modified in a batch.

FieldTypeLabelDescription
requestsUpdateNotificationRequestrepeated

BatchUpdateNotificationsResponse

The response of a call to NotificationService_BatchUpdateNotifications containing the updated notifications.

FieldTypeLabelDescription
notificationsNotificationrepeatedThe updated notifications.

ListNotificationsRequest

The request for a call to NotificationService_ListNotifications to retrieve notifications.

FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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.
filterstringA Common Expression Language (CEL) 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. For more information about the fields used for filtering, please refer to this definition. Optional.

ListNotificationsResponse

The response of a call to NotificationService_ListNotifications.

FieldTypeLabelDescription
notificationsNotificationrepeated
next_page_tokenstring

Notification

FieldTypeLabelDescription
notification_idstring
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp
created_by_user_idstring
modified_by_user_idstring
organization_idstring
recipient_user_idstring
is_readbool
full_linkstring
notification_typeNotificationKind
contentsstring
entity_idstring

UpdateNotificationRequest

FieldTypeLabelDescription
notificationNotificationThe notification to update. The notification's notification_id field is used to identify the notification to update and must be provided.
update_maskgoogle.protobuf.FieldMaskThe list of fields to be updated. Currently, the only field that can be updated is is_read.

NotificationKind

NameNumberDescription
NOTIFICATION_KIND_UNSPECIFIED0
NOTIFICATION_KIND_TEXT1
NOTIFICATION_KIND_ANNOTATION_ASSIGNED2
NOTIFICATION_KIND_MENTIONED_IN_ANNOTATION_COMMENT3
NOTIFICATION_KIND_CONDITION_TRIGGERED4
NOTIFICATION_KIND_ANNOTATION_STATE_CHANGED5
NOTIFICATION_KIND_REPORT_READY6

NotificationService

Method NameRequest TypeResponse TypeDescription
ListNotificationsListNotificationsRequestListNotificationsResponseRetrieves notifications using an optional filter.
BatchUpdateNotificationsBatchUpdateNotificationsRequestBatchUpdateNotificationsResponseBatch updates a list of notifications using the list of fields specified in their respective update_masks.

On this page