Topic schema

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.

PropTypeDefault
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.

PropTypeDefault
subscriber?
SubscriberDto
-
topic?
TopicResponseDto
-
createdAt?
string
-
id?
string
-

Subscriber

Subscriber is a user who can receive notifications. Read more about subscribers on subscribers concept page.

PropTypeDefault
updatedAt?
string
-
createdAt?
string
-
deleted?
boolean
-
environmentId?
string
-
organizationId?
string
-
subscriberId?
string
-
timezone?
string
-
data?
{ [k: string]: any; } | null
-
v?
number
-
lastOnlineAt?
string
-
isOnline?
boolean
-
topics?
string[]
-
channels?
ChannelSettingsDto[]
-
locale?
string
-
avatar?
string
-
phone?
string
-
email?
string
-
lastName?
string
-
firstName?
string
-
id?
string
-

On this page

Edit this page on GitHub