API Reference
- 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 subscriber
Get subscriber by your internal id used to identify the subscriber
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
Query Parameters
Includes the topics associated with the subscriber
Response
The unique identifier of the environment associated with this subscriber.
The unique identifier of the organization to which the subscriber belongs.
The timestamp indicating when the subscriber was created, in ISO 8601 format.
Indicates whether the subscriber has been deleted.
The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
The timestamp indicating when the subscriber was last updated, in ISO 8601 format.
The version of the subscriber document.
The internal ID generated by Novu for your subscriber. This ID does not match the subscriberId
used in your queries. Refer to subscriberId
for that identifier.
The URL of the subscriber's avatar image.
An array of channel settings associated with the subscriber.
The unique identifier of the integration associated with this channel.
Credentials payload for the specified provider
Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider.
alert_uid for grafana on-call webhook payload
Channel specification for Mattermost chat notifications
Contains an array of the subscriber device tokens for a given provider. Used on Push integrations
link_to_upstream_details property fo grafana on call webhook
image_url property fo grafana on call webhook
state property fo grafana on call webhook
title to be used with grafana on call webhook
The provider identifier for the credentials
slack
, discord
, msteams
, mattermost
, ryver
, zulip
, grafana-on-call
, getstream
, rocket-chat
, whatsapp-business
, fcm
, apns
, expo
, one-signal
, pushpad
, push-webhook
, pusher-beams
The integration identifier
The email address of the subscriber.
The first name of the subscriber.
Indicates whether the subscriber is currently online.
The last name of the subscriber.
The timestamp indicating when the subscriber was last online, in ISO 8601 format.
The locale setting of the subscriber, indicating their preferred language or region.
The phone number of the subscriber.
An array of topics that the subscriber is subscribed to.
Was this page helpful?