Get in-app notification feed for a particular subscriber

Java

import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.SubscriberNotificationResponse;

public class Main {
   public static void main(String[] args) {
        String apiKey = "<NOVU_API_KEY>";
        Novu novu = new Novu(apiKey);
        String subscriberId = "<SUBSCRIBER_ID>";

        SubscriberNotificationResponse response = novu.getSubscriberNotificationsFeed(subscriberId);
    }
}

Response

{
  "data": [
    {
      "_environmentId": "string",
      "_feedId": "string",
      "_id": "string",
      "_messageTemplateId": "string",
      "_notificationId": "string",
      "_organizationId": "string",
      "_subscriberId": "string",
      "_templateId": "string",
      "channel": "in_app",
      "createdAt": "string",
      "cta": {
        "action": {
          "buttons": [
            {
              "content": "string",
              "resultContent": "string",
              "type": "primary"
            }
          ],
          "result": {
            "payload": "object",
            "type": "primary"
          },
          "status": "pending"
        },
        "data": {
          "url": "string"
        },
        "type": "redirect"
      },
      "deviceTokens": [
        "string"
      ],
      "directWebhookUrl": "string",
      "email": "string",
      "errorId": "string",
      "errorText": "string",
      "lastSeenDate": "string",
      "overrides": "object",
      "payload": "object",
      "phone": "string",
      "providerId": "string",
      "seen": "boolean",
      "status": "sent",
      "subject": "string",
      "subscriber": {
        "__v": "number",
        "_environmentId": "string",
        "_id": "string",
        "_organizationId": "string",
        "avatar": "string",
        "channels": [
          {
            "_integrationId": "string",
            "credentials": {
              "channel": "string",
              "deviceTokens": [
                "string"
              ],
              "webhookUrl": "string"
            },
            "integrationIdentifier": "string",
            "providerId": "slack"
          }
        ],
        "createdAt": "string",
        "deleted": "boolean",
        "email": "string",
        "firstName": "string",
        "isOnline": "boolean",
        "lastName": "string",
        "lastOnlineAt": "string",
        "locale": "string",
        "phone": "string",
        "subscriberId": "string",
        "updatedAt": "string"
      },
      "template": {
        "_creatorId": "string",
        "_environmentId": "string",
        "_id": "string",
        "_notificationGroupId": "string",
        "_organizationId": "string",
        "_parentId": "string",
        "active": "boolean",
        "critical": "boolean",
        "data": "object",
        "deleted": "boolean",
        "deletedAt": "string",
        "deletedBy": "string",
        "description": "string",
        "draft": "boolean",
        "name": "string",
        "notificationGroup": {
          "_environmentId": "string",
          "_id": "string",
          "_organizationId": "string",
          "_parentId": "string",
          "name": "string"
        },
        "preferenceSettings": {
          "chat": "boolean",
          "email": "boolean",
          "in_app": "boolean",
          "push": "boolean",
          "sms": "boolean"
        },
        "steps": [
          {
            "_id": "string",
            "_parentId": "object",
            "_templateId": "string",
            "active": "boolean",
            "filters": [
              {
                "children": [
                  {
                    "field": "string",
                    "operator": "LARGER",
                    "true": "subscriber",
                    "value": "string"
                  }
                ],
                "isNegated": "boolean",
                "type": "BOOLEAN",
                "value": "AND"
              }
            ],
            "name": "string",
            "replyCallback": "object",
            "shouldStopOnFail": "boolean",
            "template": "object",
            "uuid": "string"
          }
        ],
        "tags": [
          "string"
        ],
        "triggers": [
          {
            "identifier": "string",
            "subscriberVariables": [
              {
                "name": "string"
              }
            ],
            "type": "string",
            "variables": [
              {
                "name": "string"
              }
            ]
          }
        ],
        "workflowIntegrationStatus": "object"
      },
      "templateIdentifier": "string",
      "title": "string",
      "transactionId": "string"
    }
  ],
  "hasMore": "boolean",
  "page": "number",
  "pageSize": "number"
}

Path Parameters

subscriberId

string

required

Query Parameters

page

number

limit

number

default: 10

read

boolean

seen

boolean

payload

string

Base64 encoded string of the partial payload JSON object

Response

200 - application/json

page

number

required

The current page of the paginated response

hasMore

boolean

required

Does the list have more items to fetch

pageSize

number

required

Number of items on each page

data

object[]

required

The list of items matching the query

Show child attributes

data._id

string

data._templateId

string

required

data._environmentId

string

required

data._messageTemplateId

string

required

data._organizationId

string

required

data._notificationId

string

required

data._subscriberId

string

required

data.subscriber

object

Show child attributes

data.subscriber._id

string

The internal id novu generated for your subscriber, this is not the subscriberId matching your query. See subscriberId for that

data.subscriber.firstName

string

data.subscriber.lastName

string

data.subscriber.email

string

data.subscriber.phone

string

data.subscriber.avatar

string

data.subscriber.locale

string

data.subscriber.subscriberId

string

required

The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems

data.subscriber.channels

object[]

Channels settings for subscriber

Show child attributes

data.subscriber.channels.providerId

enum<string>

required

The provider identifier for the credentials

Available options:

slack,

discord,

msteams,

mattermost,

ryver,

zulip,

grafana-on-call,

getstream,

rocket-chat,

fcm,

apns,

expo,

one-signal,

pushpad,

push-webhook,

pusher-beams

data.subscriber.channels.integrationIdentifier

string

The integration identifier

data.subscriber.channels.credentials

object

required

Credentials payload for the specified provider

Show child attributes

data.subscriber.channels.credentials.webhookUrl

string

required

Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider.

data.subscriber.channels.credentials.channel

string

Channel specification for Mattermost chat notifications

data.subscriber.channels.credentials.deviceTokens

string[]

Contains an array of the subscriber device tokens for a given provider. Used on Push integrations

data.subscriber.channels.credentials.alertUid

string

alert_uid for grafana on-call webhook payload

data.subscriber.channels.credentials.title

string

title to be used with grafana on call webhook

data.subscriber.channels.credentials.imageUrl

string

image_url property fo grafana on call webhook

data.subscriber.channels.credentials.state

string

state property fo grafana on call webhook

data.subscriber.channels.credentials.externalUrl

string

link_to_upstream_details property fo grafana on call webhook

data.subscriber.channels._integrationId

string

required

Id of the integration that is used for this channel

data.subscriber.isOnline

boolean

data.subscriber.lastOnlineAt

string

data.subscriber._organizationId

string

required

data.subscriber._environmentId

string

required

data.subscriber.deleted

boolean

required

data.subscriber.createdAt

string

required

data.subscriber.updatedAt

string

required

data.subscriber.__v

number

data.template

object

Show child attributes

data.template._id

string

data.template.name

string

required

data.template.description

string

required

data.template.active

boolean

required

data.template.draft

boolean

required

data.template.preferenceSettings

object

required

Show child attributes

data.template.preferenceSettings.email

boolean

data.template.preferenceSettings.sms

boolean

data.template.preferenceSettings.in_app

boolean

data.template.preferenceSettings.chat

boolean

data.template.preferenceSettings.push

boolean

data.template.critical

boolean

required

data.template.tags

string[]

required

data.template.steps

object[]

required

Show child attributes

data.template.steps._id

string

data.template.steps.uuid

string

data.template.steps.name

string

data.template.steps._templateId

string

data.template.steps.active

boolean

data.template.steps.shouldStopOnFail

boolean

data.template.steps.template

object

data.template.steps.filters

object[]

Show child attributes

data.template.steps.filters.isNegated

boolean

required

data.template.steps.filters.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

data.template.steps.filters.value

enum<string>

required

Available options:

AND,

OR

data.template.steps.filters.children

object[]

required

Show child attributes

data.template.steps.filters.children.field

string

required

data.template.steps.filters.children.value

string

required

data.template.steps.filters.children.operator

enum<string>

required

Available options:

LARGER,

SMALLER,

LARGER_EQUAL,

SMALLER_EQUAL,

EQUAL,

NOT_EQUAL,

ALL_IN,

ANY_IN,

NOT_IN,

BETWEEN,

NOT_BETWEEN,

LIKE,

NOT_LIKE,

IN

data.template.steps.filters.children.on

enum<string>

required

Available options:

subscriber,

payload

data.template.steps._parentId

object

data.template.steps.metadata

object

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

data.template.steps.metadata.amount

number

data.template.steps.metadata.unit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.template.steps.metadata.digestKey

string

data.template.steps.metadata.type

enum<string>

required

Available options:

regular,

backoff

data.template.steps.metadata.backoff

boolean

data.template.steps.metadata.backoffAmount

number

data.template.steps.metadata.backoffUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.template.steps.metadata.updateMode

boolean

data.template.steps.replyCallback

object

data.template.steps.variants

object

Show child attributes

data.template.steps.variants._id

string

data.template.steps.variants.uuid

string

data.template.steps.variants.name

string

data.template.steps.variants._templateId

string

data.template.steps.variants.active

boolean

data.template.steps.variants.shouldStopOnFail

boolean

data.template.steps.variants.template

object

data.template.steps.variants.filters

object[]

Show child attributes

data.template.steps.variants.filters.isNegated

boolean

required

data.template.steps.variants.filters.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

data.template.steps.variants.filters.value

enum<string>

required

Available options:

AND,

OR

data.template.steps.variants.filters.children

object[]

required

Show child attributes

data.template.steps.variants.filters.children.field

string

required

data.template.steps.variants.filters.children.value

string

required

data.template.steps.variants.filters.children.operator

enum<string>

required

Available options:

LARGER,

SMALLER,

LARGER_EQUAL,

SMALLER_EQUAL,

EQUAL,

NOT_EQUAL,

ALL_IN,

ANY_IN,

NOT_IN,

BETWEEN,

NOT_BETWEEN,

LIKE,

NOT_LIKE,

IN

data.template.steps.variants.filters.children.on

enum<string>

required

Available options:

subscriber,

payload

data.template.steps.variants._parentId

object

data.template.steps.variants.metadata

object

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

data.template.steps.variants.metadata.amount

number

data.template.steps.variants.metadata.unit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.template.steps.variants.metadata.digestKey

string

data.template.steps.variants.metadata.type

enum<string>

required

Available options:

regular,

backoff

data.template.steps.variants.metadata.backoff

boolean

data.template.steps.variants.metadata.backoffAmount

number

data.template.steps.variants.metadata.backoffUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.template.steps.variants.metadata.updateMode

boolean

data.template.steps.variants.replyCallback

object

data.template._organizationId

string

required

data.template._creatorId

string

required

data.template._environmentId

string

required

data.template.triggers

object[]

required

Show child attributes

data.template.triggers.type

enum<string>

required

Available options:

event

data.template.triggers.identifier

string

required

data.template.triggers.variables

object[]

required

Show child attributes

data.template.triggers.variables.name

string

required

data.template.triggers.subscriberVariables

object[]

Show child attributes

data.template.triggers.subscriberVariables.name

string

required

data.template._notificationGroupId

string

required

data.template._parentId

string

data.template.deleted

boolean

required

data.template.deletedAt

string

required

data.template.deletedBy

string

required

data.template.notificationGroup

object

Show child attributes

data.template.notificationGroup._id

string

data.template.notificationGroup.name

string

required

data.template.notificationGroup._environmentId

string

required

data.template.notificationGroup._organizationId

string

required

data.template.notificationGroup._parentId

string

data.template.data

object

data.template.workflowIntegrationStatus

object

data.templateIdentifier

string

data.createdAt

string

data.content

required

Show child attributes

data.content.type

enum<string>

required

Available options:

text,

button

data.content.content

string

required

data.content.url

string

data.content.styles

object

Show child attributes

data.content.styles.textAlign

enum<string>

Available options:

left,

right,

center

data.transactionId

string

required

data.subject

string

data.channel

enum<string>

required

Available options:

in_app,

email,

sms,

chat,

push

data.seen

boolean

required

data.email

string

data.phone

string

data.directWebhookUrl

string

data.providerId

string

data.deviceTokens

string[]

data.title

string

data.lastSeenDate

string

required

data.cta

object

required

Show child attributes

data.cta.type

enum<string>

Available options:

redirect

data.cta.data

object

required

Show child attributes

data.cta.data.url

string

data.cta.action

object

Show child attributes

data.cta.action.status

enum<string>

Available options:

pending,

done

data.cta.action.buttons

object[]

Show child attributes

data.cta.action.buttons.type

enum<string>

required

Available options:

primary,

secondary,

clicked

data.cta.action.buttons.content

string

required

data.cta.action.buttons.resultContent

string

data.cta.action.result

object

Show child attributes

data.cta.action.result.payload

object

data.cta.action.result.type

enum<string>

Available options:

primary,

secondary,

clicked

data._feedId

string

data.status

enum<string>

required

Available options:

sent,

error,

warning

data.errorId

string

required

data.errorText

string

required

data.payload

object

required

The payload that was used to send the notification trigger

data.overrides

object

required

Provider specific overrides used when triggering the notification