Get in-app notification feed for a particular subscriber

GET

subscribers

{subscriberId}

notifications

feed

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.subscribers.notifications.feed({
    subscriberId: "<id>",
    payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=",
  });

  // Handle the result
  console.log(result);
}

run();

{
  "totalCount": 5,
  "hasMore": true,
  "data": [
    {
      "_id": "615c1f2f9b0c5b001f8e4e3b",
      "_templateId": "template_12345",
      "_environmentId": "env_67890",
      "_messageTemplateId": "message_template_54321",
      "_organizationId": "org_98765",
      "_notificationId": "notification_123456",
      "_subscriberId": "subscriber_112233",
      "_feedId": "feed_445566",
      "_jobId": "job_778899",
      "createdAt": "2024-12-10T10:10:59.639Z",
      "updatedAt": "2024-12-10T10:10:59.639Z",
      "actor": {
        "data": null,
        "type": "none"
      },
      "subscriber": {
        "_id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "avatar": "<string>",
        "subscriberId": "<string>"
      },
      "transactionId": "transaction_123456",
      "templateIdentifier": "template_abcdef",
      "providerId": "provider_xyz",
      "content": "This is a test notification content.",
      "subject": "Test Notification Subject",
      "channel": "in_app",
      "read": false,
      "seen": true,
      "deleted": false,
      "deviceTokens": [
        "token1",
        "token2"
      ],
      "cta": {
        "type": "redirect",
        "data": {
          "url": "<string>"
        },
        "action": {
          "status": "pending",
          "buttons": [
            {
              "type": "primary",
              "content": "<string>",
              "resultContent": "<string>"
            }
          ],
          "result": {
            "payload": {},
            "type": "primary"
          }
        }
      },
      "status": "sent",
      "payload": {
        "key": "value"
      },
      "overrides": {
        "overrideKey": "overrideValue"
      }
    }
  ],
  "pageSize": 2,
  "page": 1
}

Authorizations

Authorization

string

header

required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Headers

idempotency-key

string

A header for idempotency purposes

Path Parameters

subscriberId

string

required

Query Parameters

page

number

limit

number

default:

Required range: x < 100

read

boolean

seen

boolean

payload

string

Base64 encoded string of the partial payload JSON object

Response

200

application/json

hasMore

boolean

required

Indicates if there are more notifications to load.

data

object[]

required

Array of notifications returned in the response.

data._id

string

required

Unique identifier for the notification.

data._templateId

string

required

Identifier for the template used to generate the notification.

data._environmentId

string

required

Identifier for the environment where the notification is sent.

data._messageTemplateId

string

required

Identifier for the message template used.

data._organizationId

string

required

Identifier for the organization sending the notification.

data._notificationId

string

required

Unique identifier for the notification instance.

data._subscriberId

string

required

Unique identifier for the subscriber receiving the notification.

data._feedId

string

required

Identifier for the feed associated with the notification.

data._jobId

string

required

Identifier for the job that triggered the notification.

data.transactionId

string

required

Unique identifier for the transaction associated with the notification.

data.content

string

required

The main content of the notification.

data.channel

enum<string>

required

Channel type through which the message is sent

Available options:

in_app,

email,

sms,

chat,

push

data.read

boolean

required

Indicates whether the notification has been read by the subscriber.

data.seen

boolean

required

Indicates whether the notification has been seen by the subscriber.

data.deleted

boolean

required

Indicates whether the notification has been deleted.

data.cta

object

required

Call-to-action information associated with the notification.

data.status

enum<string>

required

Current status of the notification.

Available options:

sent,

error,

warning

data.createdAt

string | null

Timestamp indicating when the notification was created.

data.updatedAt

string | null

Timestamp indicating when the notification was last updated.

data.actor

object

Actor details related to the notification, if applicable.

data.subscriber

object

Subscriber details associated with this notification.

data.templateIdentifier

string | null

Identifier for the template used, if applicable.

data.providerId

string | null

Identifier for the provider that sends the notification.

data.subject

string | null

The subject line for email notifications, if applicable.

data.deviceTokens

string[] | null

Device tokens for push notifications, if applicable.

data.payload

object

The payload that was used to send the notification trigger.

data.overrides

object

Provider-specific overrides used when triggering the notification.

pageSize

number

required

The number of notifications returned in this response.

page

number

required

The current page number of the notifications.

totalCount

number

Total number of notifications available.

Was this page helpful?

Suggest edits Raise issue

Update subscriber online status Get the unseen in-app notifications count for subscribers feed

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.subscribers.notifications.feed({
    subscriberId: "<id>",
    payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=",
  });

  // Handle the result
  console.log(result);
}

run();

{
  "totalCount": 5,
  "hasMore": true,
  "data": [
    {
      "_id": "615c1f2f9b0c5b001f8e4e3b",
      "_templateId": "template_12345",
      "_environmentId": "env_67890",
      "_messageTemplateId": "message_template_54321",
      "_organizationId": "org_98765",
      "_notificationId": "notification_123456",
      "_subscriberId": "subscriber_112233",
      "_feedId": "feed_445566",
      "_jobId": "job_778899",
      "createdAt": "2024-12-10T10:10:59.639Z",
      "updatedAt": "2024-12-10T10:10:59.639Z",
      "actor": {
        "data": null,
        "type": "none"
      },
      "subscriber": {
        "_id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "avatar": "<string>",
        "subscriberId": "<string>"
      },
      "transactionId": "transaction_123456",
      "templateIdentifier": "template_abcdef",
      "providerId": "provider_xyz",
      "content": "This is a test notification content.",
      "subject": "Test Notification Subject",
      "channel": "in_app",
      "read": false,
      "seen": true,
      "deleted": false,
      "deviceTokens": [
        "token1",
        "token2"
      ],
      "cta": {
        "type": "redirect",
        "data": {
          "url": "<string>"
        },
        "action": {
          "status": "pending",
          "buttons": [
            {
              "type": "primary",
              "content": "<string>",
              "resultContent": "<string>"
            }
          ],
          "result": {
            "payload": {},
            "type": "primary"
          }
        }
      },
      "status": "sent",
      "payload": {
        "key": "value"
      },
      "overrides": {
        "overrideKey": "overrideValue"
      }
    }
  ],
  "pageSize": 2,
  "page": 1
}

API Reference

Events

Notifications

Integrations

Subscribers

Messages

Topics

Get in-app notification feed for a particular subscriber

Authorizations

Headers

Path Parameters

Query Parameters

Response