Subscribers
Get in-app notification feed for a particular subscriber
- 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
- GETFilter topics
- POSTTopic creation
- POSTSubscribers addition
- GETCheck topic subscriber
- POSTSubscribers removal
- GETGet topic
- DELDelete topic
- PATCHRename a topic
- GETGet notifications
- GETGet notification statistics
- GETGet notification graph statistics
- GETGet notification
- GETGet workflows
- POSTCreate workflow
- GETGet workflow
- PUTUpdate workflow
- DELDelete workflow
- PUTUpdate workflow status
- POSTCreate workflow overrides
- GETGet workflow overrides
- GETGet workflow override
- GETGet workflow override by id
- PUTUpdate workflow override by id
- PUTUpdate workflow override
- DELDelete workflow override
- GETGet workflow groups
- POSTCreate workflow group
- GETGet workflow group
- DELDelete workflow group
- PATCHUpdate workflow group
- GETGet integrations
- POSTCreate integration
- GETGet active integrations
- GETGet webhook support status for provider
- PUTUpdate integration
- DELDelete integration
- POSTSet integration as primary
- GETFilter layouts
- POSTLayout creation
- GETGet layout
- DELDelete layout
- PATCHUpdate a layout
- POSTSet default layout
- GETGet execution details
Subscribers
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Subscribers
Get in-app notification feed for a particular subscriber
GET
/
v1
/
subscribers
/
{subscriberId}
/
notifications
/
feed
Authorization
string
*
Authorization
Required
string
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
subscriberId
string
*
subscriberId
Required
string
page
number
page
number
limit
number
limit
number
read
boolean
read
boolean
seen
boolean
seen
boolean
payload
string
payload
string
Base64 encoded string of the partial payload JSON object
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
Authorization
string
headerrequiredAPI key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
subscriberId
string
requiredQuery Parameters
page
number
limit
number
default: 10read
boolean
seen
boolean
payload
string
Base64 encoded string of the partial payload JSON object
Response
200 - application/json
page
number
requiredThe current page of the paginated response
hasMore
boolean
requiredDoes the list have more items to fetch
pageSize
number
requiredNumber of items on each page
data
object[]
requiredThe list of items matching the query
data.totalCount
number
data.hasMore
boolean
requireddata.data
string[]
requireddata.pageSize
number
requireddata.page
number
requiredimport 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"
}