Get in-app notification feed for a particular subscriber
API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate subscriber credentials
- DELDelete subscriber credentials by providerId
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETGet in-app notification feed for a particular subscriber
- GETGet the unseen in-app notifications count for subscribers feed
- POSTMark a subscriber feed message as seen
- POSTMarks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Organizations
Get in-app notification feed for a particular subscriber
GET
/
v1
/
subscribers
/
{subscriberId}
/
notifications
/
feed
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);
}
}
{
"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"
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
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);
}
}
{
"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"
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
Query Parameters
Required range:
x < 100
Base64 encoded string of the partial payload JSON object
Response
200
application/json
The current page of the paginated response
Does the list have more items to fetch
Number of items on each page
Was this page helpful?
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);
}
}
{
"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"
}