Topic
Topic is a collection of subscribers that share a common interest. Subscriber can subscribe to multiple topics. When a subscriber is subscribed to a topic, they will receive notifications generated by workflows triggered to that topic.string
The identifier of the topic
string
The unique key of the topic
string
The name of the topic
string
The date the topic was created
string
The date the topic was last updated
TopicSubscription
TopicSubscription is a relationship between a subscriber and a topic. It is used to track which subscribers are subscribed to which topics and when they subscribed.createdAt is the date and time the subscription was created.
string
The internal ID generated by Novu for the subscription. Use this when referencing the subscription by its database ID.
string
The user-supplied key provided when creating the subscription. Use this to look up or manage a specific subscription within a topic.
string
The date and time the subscription was created
TopicResponseDto
Topic information
SubscriberDto
Subscriber information
string[]
Context keys that scope this subscription (e.g., tenant:org-a, project:proj-123)
Subscriber
Subscriber is a user who can receive notifications. 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.