- API Overview
- API Rate Limiting
Events
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 preferences by level
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETGet in-app notifications feed of subscriber.
- GETGet unseen in-app notifications count
- POSTMarks a message as read/unread, seen/unseen.
- POSTMarks all messages as read/unread, seen/unseen.
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
- GET
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Environments
Changes
Execution Details
Feeds
Tenants
Organizations
Messages
Get subscribers
Returns a list of subscribers, could paginated using the page and limit query parameter
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.BulkSubscriberResponse;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_SECRET_KEY>";
Novu novu = new Novu(apiKey);
Integer page = 0;
Integer limit = 10;
BulkSubscriberResponse response = novu.getSubscribers(page, limit);
}
}
{
"data": [
{
"__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"
}
],
"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.BulkSubscriberResponse;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_SECRET_KEY>";
Novu novu = new Novu(apiKey);
Integer page = 0;
Integer limit = 10;
BulkSubscriberResponse response = novu.getSubscribers(page, limit);
}
}
{
"data": [
{
"__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"
}
],
"hasMore": "boolean",
"page": "number",
"pageSize": "number"
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Query Parameters
Response
The current page of the paginated response
Does the list have more items to fetch
Number of items on each page
The list of items matching the query
The internal id novu generated for your subscriber, this is not the subscriberId matching your query. See subscriberId for that
The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems
Channels settings for subscriber
The provider identifier for the credentials
The integration identifier
Credentials payload for the specified provider
Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider.
Channel specification for Mattermost chat notifications
Contains an array of the subscriber device tokens for a given provider. Used on Push integrations
alert_uid for grafana on-call webhook payload
title to be used with grafana on call webhook
image_url property fo grafana on call webhook
state property fo grafana on call webhook
link_to_upstream_details property fo grafana on call webhook
Id of the integration that is used for this channel
Topics that subscriber belongs to
Was this page helpful?
import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.BulkSubscriberResponse;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_SECRET_KEY>";
Novu novu = new Novu(apiKey);
Integer page = 0;
Integer limit = 10;
BulkSubscriberResponse response = novu.getSubscribers(page, limit);
}
}
{
"data": [
{
"__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"
}
],
"hasMore": "boolean",
"page": "number",
"pageSize": "number"
}