Subscriber schema - Novu

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.

<ResponseField name="id" type="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. </ResponseField> <ResponseField name="firstName" type="string"> The first name of the subscriber. </ResponseField> <ResponseField name="lastName" type="string"> The last name of the subscriber. </ResponseField> <ResponseField name="email" type="string"> The email address of the subscriber. </ResponseField> <ResponseField name="phone" type="string"> The phone number of the subscriber. </ResponseField> <ResponseField name="avatar" type="string"> The URL of the subscriber's avatar image. </ResponseField> <ResponseField name="locale" type="string"> The locale setting of the subscriber, indicating their preferred language or region. </ResponseField> <ResponseField name="channels" type="ChannelSettingsDto[]"> An array of channel settings associated with the subscriber. </ResponseField> <ResponseField name="topics" type="string[]"> An array of topics that the subscriber is subscribed to. </ResponseField> <ResponseField name="isOnline" type="boolean"> Indicates whether the subscriber is currently online. </ResponseField> <ResponseField name="lastOnlineAt" type="string"> The timestamp indicating when the subscriber was last online, in ISO 8601 format. </ResponseField> <ResponseField name="v" type="number"> The version of the subscriber document. </ResponseField> <ResponseField name="data" type="{ [k: string]: any; }"> Additional custom data for the subscriber </ResponseField> <ResponseField name="timezone" type="string"> Timezone of the subscriber </ResponseField> <ResponseField name="subscriberId" type="string"> The identifier used to create this subscriber, which typically corresponds to the user ID in your system. </ResponseField> <ResponseField name="organizationId" type="string"> The unique identifier of the organization to which the subscriber belongs. </ResponseField> <ResponseField name="environmentId" type="string"> The unique identifier of the environment associated with this subscriber. </ResponseField> <ResponseField name="deleted" type="boolean"> Indicates whether the subscriber has been deleted. </ResponseField> <ResponseField name="createdAt" type="string"> The timestamp indicating when the subscriber was created, in ISO 8601 format. </ResponseField> <ResponseField name="updatedAt" type="string"> The timestamp indicating when the subscriber was last updated, in ISO 8601 format. </ResponseField>

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 type

<ResponseField name="providerId" type="ChatOrPushProviderEnum"> The provider identifier for the credentials </ResponseField> <ResponseField name="integrationIdentifier" type="string"> The integration identifier </ResponseField> <ResponseField name="credentials" type="ChannelCredentials"> Credentials payload for the specified provider </ResponseField> <ResponseField name="integrationId" type="string"> The unique identifier of the integration associated with this channel. </ResponseField>

Credentials

Credentials like deviceTokens, webhookUrl, etc for a specific integration. providerId could be chat channel providerId or push channel providerId.