Stream: dev

Topic: Notifications API usage and future


view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 24 2025 at 16:23):

The core team just talked a lot about the Notifications API. Here's its current state: https://guides.dataverse.org/en/6.7/api/native-api.html#notifications

I'm wondering if anyone out there is actually using the Notifications API. Can we safely make breaking changes? Do you want to have input on how it works in the future?

The context for this is that we're starting to think about how to improve the Notifications API for the SPA to use it: https://github.com/IQSS/dataverse-frontend/issues/775

But I'm also curious if existing apps are using that API and how they would like it to work.

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 24 2025 at 16:23):

@Johannes D @Vera Clemens does your custom UI call into the Notifications API?

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 24 2025 at 16:24):

@Jan Range does pyDataverse or dvcli display notifications? Do you want it to some day? (I was thinking about writing a little Python script to display notifications.)

view this post on Zulip Oliver Bertuch (Jul 24 2025 at 20:01):

I'm not currently using the Notification API. A long time ago we talked about this, though. And at the time, there was consensus that it would make sense to have the notification system pluggable. Meaning: not just have the option to send an email and display something in the UI. But also allow notifications to flow into messaging systems (Slack et al) and event stream systems (Kafka, RabbitMQ, et al).

view this post on Zulip Jan Range (Jul 28 2025 at 14:31):

@Philip Durbin ๐Ÿš€ DVCLI does not yet feature the notifications API, but we can add it. I guess it would also be quite useful in pyDataverse for automation.

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 28 2025 at 14:34):

@Jan Range if it's helpful, I'm playing around with a Python script to display notifications at https://github.com/gdcc/dataverse-recipes/compare/notifications but please be advised that it relies unmerged, experimental, work-in-progress code at https://github.com/IQSS/dataverse/compare/develop...11648-notification-patterns

view this post on Zulip Jan Range (Jul 28 2025 at 14:39):

Alright, so the recipe relies on the cases/enumeration such as INGESTCOMPLETED - Pretty cool feature! I think this could be very helpful in a couple of cases to check back on certain states. DVUploader for ingest checks and EasyReview for review updates would come to my mind.

In terms of implementation, would it be better to wait until the diff you have posted is merged? Or is this simply an addition to the existing response schema and we can add it when released?

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 28 2025 at 14:41):

Yes, you should absolutely wait. :sweat_smile:

All of these notifications feel a bit bespoke but I'm trying to figure out if there are some patterns we can lean into. Please stay tuned. :smile:

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 28 2025 at 14:41):

And yes, I can imagine it's useful to check in a loop if ingest is done.

view this post on Zulip Jan Range (Jul 28 2025 at 14:42):

Shall we track it somewhere? Maybe an issue at pyDataverse or DVCLI

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 28 2025 at 14:43):

If you want. Like I said above, for now we're tracking it for the SPA at https://github.com/IQSS/dataverse-frontend/issues/775

view this post on Zulip Jan Range (Jul 28 2025 at 14:46):

Opened an issue to not forget about it

https://github.com/gdcc/pyDataverse/issues/221

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 28 2025 at 14:46):

Looks great, thanks!

view this post on Zulip Dieuwertje Bloemen (Aug 06 2025 at 15:09):

I've just tried to retrieve all of my notifications as an admin, and I'm getting a 500 response. When I try with a normal user, it works. But with two different admin accounts it's not working. Is anyone else having the same issue? Could maybe be due to the number of notifications (1000+)?

view this post on Zulip Philip Durbin ๐Ÿš€ (Aug 06 2025 at 15:26):

Hmm, @Omer M Fahim found something similar in #11683 but as I said there, it may not be the sheer number of notifications. In that issue you'll see a NullPointerException. @Dieuwertje Bloemen if you have access to server.log you might see a similar error. Please feel free to add any findings to that issue!


Last updated: Nov 01 2025 at 14:11 UTC