DOC-API-MODEL-schema-1kaqut27uf#overview
ChannelRegistration
Registration state and credential count for one notification channel.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1kaqut27uf#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1kaqut27uf#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1kaqut27uf#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1kaqut27uf#field-channelSection ID: DOC-API-MODEL-schema-1kaqut27uf#response-field-channelchannel | string (CHANNEL_PUSH, CHANNEL_IN_APP, CHANNEL_EMAIL, CHANNEL_SMS, CHANNEL_CHAT) or integer (int32) | Optional; explicit presence | Notification channel represented by this registration. |
Section ID: DOC-API-MODEL-schema-1kaqut27uf#field-registeredSection ID: DOC-API-MODEL-schema-1kaqut27uf#response-field-registeredregistered | boolean | Optional | Whether the subscriber has a registration for this channel. |
Section ID: DOC-API-MODEL-schema-1kaqut27uf#field-credentialcountSection ID: DOC-API-MODEL-schema-1kaqut27uf#response-field-credentialcountcredentialCount | string (int64) | Optional | See meaning below. Pattern: ^-?\d+$. |
credentialCount
Number of delivery credentials registered for the channel.
e.g., number of device tokens
Values of channel
Section ID: DOC-API-MODEL-schema-1kaqut27uf#response-values-channel
Delivery channel for a notification that does not expect a reply.
| Value | No. | Form | Meaning |
|---|---|---|---|
CHANNEL_PUSH | 0 | Canonical | See meaning below. |
CHANNEL_IN_APP | 1 | Canonical | See meaning below. |
CHANNEL_EMAIL | 2 | Canonical | See meaning below. |
CHANNEL_SMS | 3 | Canonical | See meaning below. |
CHANNEL_CHAT | 4 | Canonical | See meaning below. |
CHANNEL_PUSH
Deliver a device push notification through the configured push provider.
FCM/APNS push notifications
CHANNEL_IN_APP
Deliver the notification to the in-app inbox.
Novu Inbox (notification center)
CHANNEL_EMAIL
Send a one-way email notification through the configured email provider.
SendGrid/SES - do-not-reply only
CHANNEL_SMS
Send a one-way SMS notification, such as an alert or authentication message.
Twilio - do-not-reply only (alerts, 2FA)
CHANNEL_CHAT
Send a one-way message to an integrated chat destination.
Slack, Discord, MS Teams - one-way notifications
Where used
Section ID: DOC-API-MODEL-schema-1kaqut27uf#where-used
| Reference | Relationship |
|---|---|
| Get registered notification channels | POST /api/v1/notifications/get-registered-channels |
| Get the caller's subscriber profile | POST /api/v1/notifications/manage/get-subscriber |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1kaqut27uf