Topic schema Model API Reference (Topics)
Reference the Novu topic schema used in API requests and responses. Review fields, data types, and object structure for this resource.
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.
| Prop | Type | Default |
|---|---|---|
updatedAt? | string | - |
createdAt? | string | - |
name? | string | - |
key? | string | - |
id? | string | - |
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.
| Prop | Type | Default |
|---|---|---|
contextKeys? | string[] | - |
subscriber? | SubscriberDto | - |
topic? | TopicResponseDto | - |
createdAt? | string | - |
identifier? | string | - |
id? | string | - |
Subscriber
Subscriber is a user who can receive notifications. Read more about subscribers on subscribers concept page.
| Prop | Type | Default |
|---|---|---|
updatedAt? | string | - |
createdAt? | string | - |
deleted? | boolean | - |
environmentId? | string | - |
organizationId? | string | - |
subscriberId? | string | - |
timezone? | string | null | - |
data? | { [k: string]: any; } | null | - |
v? | number | - |
lastOnlineAt? | string | null | - |
isOnline? | boolean | null | - |
topics? | string[] | - |
channels? | ChannelSettingsDto[] | - |
locale? | string | null | - |
avatar? | string | null | - |
phone? | string | null | - |
email? | string | null | - |
lastName? | string | null | - |
firstName? | string | null | - |
id? | string | - |
Revert a notification action PATCH
Revert a single in-app (inbox) notification's action (primary or secondary) to pending state by its unique identifier **notificationId** and action type **actionType**.
Create a topic POST
Creates a new topic if it does not exist, or updates an existing topic if it already exists. Use ?failIfExists=true to prevent updates.