Novu•3mo ago•

4 replies

@novu/api notification feed - query API

API🚀Feature Request

Context
I have multiple workflows, each receives unique payload as input.

In my

step.email

step.email

step.inApp

step.inApp

step.push

step.push

and etc. I can format data like so:

await step.push("push-step", async () => {
  return {
    subject,
    body,
    data: {
      orgId,
    },
  };
})

await step.push("push-step", async () => {
  return {
    subject,
    body,
    data: {
      orgId,
    },
  };
})

Then

orgId

orgId

can be then used in

useNotifications

useNotifications

const { notifications, error, refetch, readAll } = useNotifications({ data: { orgId }, });

const { notifications, error, refetch, readAll } = useNotifications({ data: { orgId }, });

to fetch user's notification in context of the specified

orgId

orgId

Problem
The problem is that @novu/api

novu.subscribers.notifications.feed

novu.subscribers.notifications.feed

method does not allow to filter by

data.orgId

data.orgId

.

What's currently possible is to filter by partial input payload. From Docs:

Base64 encoded string of the partial payload JSON object

Source: https://docs.novu.co/api-reference/subscribers/retrieve-subscriber-notifications

And this is where the problem resides. As I've mentioned in the beginning, my worklows have different payload shape. This means that I cannot easily fetch the same notifications that I fetch via the

useNotifications

useNotifications

hook

Possible solutions
- Add an endpoint that exposes exactly the same data structure as the

useNotifications

useNotifications

hook. This will allow to filter by

data.orgId

data.orgId

- Add

OR

OR

method current endpoint. This way I can specify multiple partial payload inputs and fetch the notifications