Skip to content

update documentation for notification endpoint #423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BryonLewis merged 1 commit into from
May 13, 2026
Merged

update documentation for notification endpoint #423

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/UI-Notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ When a notification is detected on the client a dialog window will be displayed

## REST Endpoint

There is a REST endpoint: `POST /dive_rpc/ui_notificaitions/{id}` that takes in a DatasetId and JSON body response to display the notification to the same user with the same DatasetId currently open. I.E. If you run a task the task is able to provide information back to the user in the form of a Dialog box and provide suggestion actions like selecting a track or going to a specific frame.
There is a REST endpoint: `POST /dive_rpc/ui_notification/{id}` that takes in a DatasetId and JSON body response to display the notification to the same user with the same DatasetId currently open. I.E. If you run a task the task is able to provide information back to the user in the form of a Dialog box and provide suggestion actions like selecting a track or going to a specific frame.



Expand Down
Loading