Subscriber
Subscriber is the end user that receives notifications. Subscriber has subscriber attributes like firstName, lastName, email, phone, etc,data field to store any custom attributes in key value pairs and channel credentials for push and chat channel provider’s integrations. Read more about subscribers on subscribers concept page.
string
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.string
The first name of the subscriber.
string
The last name of the subscriber.
string
The email address of the subscriber.
string
The phone number of the subscriber.
string
The URL of the subscriber’s avatar image.
string
The locale setting of the subscriber, indicating their preferred language or region.
ChannelSettingsDto[]
An array of channel settings associated with the subscriber.
string[]
An array of topics that the subscriber is subscribed to.
boolean
Indicates whether the subscriber is currently online.
string
The timestamp indicating when the subscriber was last online, in ISO 8601 format.
number
The version of the subscriber document.
{ [k: string]: any; }
Additional custom data for the subscriber
string
Timezone of the subscriber
string
The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
string
The unique identifier of the organization to which the subscriber belongs.
string
The unique identifier of the environment associated with this subscriber.
boolean
Indicates whether the subscriber has been deleted.
string
The timestamp indicating when the subscriber was created, in ISO 8601 format.
string
The timestamp indicating when the subscriber was last updated, in ISO 8601 format.
ChannelSettingsDto
ChannelSettings are credentials for push and chat channel provider’s integrations. One subscriber can have credentials for multiple integrations of same provider of one channel typeChatOrPushProviderEnum
The provider identifier for the credentials
string
The integration identifier
ChannelCredentials
Credentials payload for the specified provider
string
The unique identifier of the integration associated with this channel.
Credentials
Credentials like deviceTokens, webhookUrl, etc for a specific integration.providerId could be chat channel providerId or push channel providerId.
string
string
string
string
string
string
string
boolean
string
string
string
string
string
string
string
string
string
boolean
boolean
TlsOptions
string
string
string
boolean
string
string
string
string
string
string
string
boolean
string
string
string
string
string
string
string
string
string
string
string
string
string
string