Notifications

Read and update the signed-in user's inbox from V3Client. The same inbox in the web app is Notifications.

list_notifications() polls for items that arrived since the last call. list_inbox_items() reads the persisted inbox, with filters.

Event types

list_inbox_items(event_type=…) and BulkInboxActionDto.filter_event_type take one of these values:

event_type	Meaning
notification.user.received_resource.shared	A resource was shared in over a receiving connection. The event carries the revision's display_name, plus file_extension and file_size.
notification.user.received_resource.updated	A received resource gained a new revision from its sender. The event carries the revision's display_name, plus file_extension and file_size.
notification.user.received_resource.revoked	The sender revoked a received resource. The event carries the connection, the local resource id and type, and when the revoke happened.
notification.user.workflow_log.completed	A workflow log entry completed. The event carries status.
notification.user.change_request.opened	A change request was opened on a System.
notification.user.job.terminal_state	A job reached a terminal state: Completed, Failed, or Canceled. The event carries job_id and terminal_state.
notification.user.access.granted	Access was granted on a resource. The event carries granted_user_id, resource_id, and permission_level.

Inbox

list_inbox_items()

• Parameters:

  • cursor (str, optional)
  • size (int, optional)
  • read (bool, optional)
  • done (bool, optional)
  • archived (bool, optional)
  • event_type (str, optional) – One of the event types.
  • http_request_timeout_secs (int, optional)

• Return Type: InboxPageDto

get_inbox_item()

• Parameters:

  • item_id (str) – (required)
  • http_request_timeout_secs (int, optional)

• Return Type: InboxItemDto

update_inbox_item()

Sets read and/or done. At least one of read or done must be set. done=True also sets the item read.

• Parameters:

  • item_id (str) – (required)
  • mark_inbox_item_dto (MarkInboxItemDto) – (required). Optional booleans read and done.
  • http_request_timeout_secs (int, optional)

• Return Type: InboxItemDto

bulk_action_inbox_items()

Applies one action to every item that matches a filter. The body does not take a list of ids.

• Parameters:

  • bulk_inbox_action_dto (BulkInboxActionDto) – (required). Filters: filter_read, filter_done, filter_archived, filter_event_type (one of the event types). Actions: read, done, archived.
  • http_request_timeout_secs (int, optional)

• Return Type: BulkInboxActionResultDto

archive_inbox_item()

• Parameters:

  • item_id (str) – (required)
  • http_request_timeout_secs (int, optional)

• Return Type: None

restore_inbox_item()

• Parameters:

  • item_id (str) – (required)
  • http_request_timeout_secs (int, optional)

• Return Type: InboxItemDto

Poll

list_notifications()

Polls new inbox items since the previous call.

• Parameters:

  • http_request_timeout_secs (int, optional)

• Return Type: NotificationPageDto