package notificationproto

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc CreateNotification (CreateNotificationRequest, CreateNotificationResponse)

  notification.proto:126

  message CreateNotificationRequest

  notification.proto:15

  • string tenant_id = 1

  • bool if_not_exists = 2

  • string name = 3

  • NotificationType notification_type = 4

  • bool enabled = 6

  • string webhook_url = 7

  • optional string webhook_method = 8

  • optional string webhook_authorization_header = 9

  • optional string comments = 90

  message CreateNotificationResponse

  notification.proto:29

  • optional NotificationError error = 1

  • uint64 notification_id = 2

• rpc DropNotification (DropNotificationRequest, DropNotificationResponse)

  notification.proto:127

  message DropNotificationRequest

  notification.proto:34

  • string tenant_id = 1

  • string name = 2

  • bool if_exists = 3

  message DropNotificationResponse

  notification.proto:40

  • optional NotificationError error = 1

• rpc ListNotification (ListNotificationRequest, ListNotificationResponse)

  notification.proto:128

  message ListNotificationRequest

  notification.proto:61

  • string tenant_id = 1

  message ListNotificationResponse

  notification.proto:65

  • optional NotificationError error = 1

  • repeated Notification notifications = 5

• rpc GetNotification (GetNotificationRequest, GetNotificationResponse)

  notification.proto:129

  message GetNotificationRequest

  notification.proto:70

  • string tenant_id = 1

  • string name = 2

  message GetNotificationResponse

  notification.proto:75

  • optional NotificationError error = 1

  • optional Notification notification = 5

• rpc AlterNotification (AlterNotificationRequest, AlterNotificationResponse)

  notification.proto:130

  message AlterNotificationRequest

  notification.proto:80

  • string tenant_id = 1

  • string name = 2

  • string operation_type = 3

  • optional bool enabled = 4

  • optional string webhook_url = 5

  • optional string webhook_method = 6

  • optional string webhook_authorization_header = 7

  • optional string comments = 8

  message AlterNotificationResponse

  notification.proto:91

  • optional NotificationError error = 1

  • uint64 notification_id = 2

• rpc ListNotificationHistory (ListNotificationHistoryRequest, ListNotificationHistoryResponse)

  notification.proto:131

  message ListNotificationHistoryRequest

  notification.proto:106

  • string tenant_id = 1

  • optional string notification_name = 2

  • optional utils.Timestamp start_time = 3

  • optional utils.Timestamp end_time = 4

  • optional int32 result_limit = 5

  • optional int32 page_size = 6

    100 by default

  • optional int64 next_page_token = 7

  • optional int64 previous_page_token = 8

  message ListNotificationHistoryResponse

  notification.proto:117

  • optional NotificationError error = 1

  • repeated NotificationHistory notification_histories = 5

  • int64 next_page_token = 6

    you can pass the next_page_token to the list request to get the next page. so does previous_page_token.

  • int64 previous_page_token = 7

Used in: GetNotificationResponse, ListNotificationResponse

• uint64 notification_id = 1

• string tenant_id = 2

• string name = 3

• NotificationType notification_type = 4

• bool enabled = 5

• string webhook_url = 6

• optional string webhook_method = 7

• optional string webhook_authorization_header = 8

• optional string comments = 90

• optional utils.Timestamp created_time = 91

• string created_by = 92

• optional utils.Timestamp updated_time = 93

• string updated_by = 94

Used in: AlterNotificationResponse, CreateNotificationResponse, DropNotificationResponse, GetNotificationResponse, ListNotificationHistoryResponse, ListNotificationResponse

• string kind = 1

• string message = 2

• int32 code = 3

Used in: ListNotificationHistoryResponse

• optional utils.Timestamp created_time = 1

• optional utils.Timestamp processed_time = 2

• string message_source = 3

• string name = 4

• string message = 5

• string status = 6

• string error_message = 7

  if notification failed, provide failed message

Used in: CreateNotificationRequest, Notification

• WEBHOOK = 0