Unread

Quick Start

Selecting a User Identifier Add the Inbox Compose a Notification View the Logs Next Steps

Developer Tools

Libraries & SDKs

Android SDK iOS SDK JavaScript SDK JavaScript Embeddable JavaScript User Client React SDK React Headless SDK Ruby SDK WebPush SDK

magicbell-go-project-client

models

services

BroadcastsService ChannelsService EventsService IntegrationsService JwtService

magicbell-java-user-client

models

ApnsTokenInstallationId ApnsToken ArrayOfMetadataApnsTokens ArrayOfMetadataExpoTokens ArrayOfMetadataFcmTokens ArrayOfMetadataSlackTokens ArrayOfMetadataTeamsTokens ArrayOfMetadataWebPushTokens AuthedUser Banner DefaultHover DefaultState Default_Dialog DiscardResult Enterprise ExpoToken FcmTokenInstallationId FcmToken Footer GetMobilePushApnsTokensParameters GetMobilePushExpoTokensParameters GetMobilePushFcmTokensParameters GetSlackTokensParameters GetTeamsTokensParameters GetWebPushTokensParameters Header Icon Images InboxConfig IncomingWebhook Keys Links MetadataApnsToken MetadataExpoToken MetadataFcmToken MetadataSlackToken MetadataTeamsToken MetadataWebPushToken Notification Oauth SlackFinishInstallResponse SlackInstallation SlackStartInstallResponseContent SlackStartInstall SlackTokenWebhook SlackToken Team TeamsTokenWebhook TeamsToken TemplatesInstallation Theme TokenMetadata UnreadHover UnreadState Unread UnseenBadge UnseenHover UnseenState Unseen WebPushStartInstallationResponse WebPushToken

services

ChannelsService ChannelsService IntegrationsService IntegrationsService

magicbell-swift-user-client

enums

extensions

APIProtocol

protocols

APIProtocol

structs

@magicbell/project-client

models

services

BroadcastsService ChannelsService EventsService IntegrationsService JwtService

@magicbell/user-client

models

ApnsToken ArrayOfMetadataApnsTokens ArrayOfMetadataExpoTokens ArrayOfMetadataFcmTokens ArrayOfMetadataSlackTokens ArrayOfMetadataTeamsTokens ArrayOfMetadataWebPushTokens DiscardResult ExpoToken FcmToken InboxConfig Links MetadataApnsToken MetadataExpoToken MetadataFcmToken MetadataSlackToken MetadataTeamsToken MetadataWebPushToken SlackFinishInstallResponse SlackInstallation SlackStartInstallResponseContent SlackStartInstall SlackToken TeamsToken TemplatesInstallation TokenMetadata WebPushStartInstallationResponse WebPushToken

services

ChannelsService IntegrationsService

API

Overview Authentication V1 API Reference OpenAPI Spec

Delivery Channels

Overview Smart Delivery

Notification Inbox

Overview HMAC Authentication

React

Identifying Users Customize the theme Inbox Tabs Localization Positioning the Inbox Set a Custom Click Handler Change the default Notification Component New notification sound Render Notifications in a Sidebar Known Issues

React Native

Getting Started Implement mobile push notifications

Browser

Change default font Change default images Notify users for new notifications

Angular

Quick Start

Vue

Quick Start

Overview Amazon SES Mailgun Ping Postmark Sendgrid

Web Push

Mobile Push

Android (FCM)iOS (APNs)

Slack

MagicBell Slack Apps Create your own app Slack Provider Overrides (and Blocks)

SMS

Twilio

Topic & Subscriptions

Overview Topics Subscriptions

Notification Primitives

Broadcast Category Channel Token Channel

Notification Rendering

Channel Templates Email Layouts Override content

Guides

Migrations

Migrating to POST /broadcasts Upgrade @magicbell/webpush to v2

Introduction

Quick Start

Selecting a User Identifier Add the Inbox Compose a Notification View the Logs Next Steps

Developer Tools

Dashboard MagicBell CLI Playground

Libraries & SDKs

Android SDK iOS SDK JavaScript SDK JavaScript Embeddable JavaScript User Client React SDK React Headless SDK Ruby SDK WebPush SDK

magicbell-go-project-client

models

services

BroadcastsService ChannelsService EventsService IntegrationsService JwtService

magicbell-java-user-client

models

services

ChannelsService ChannelsService IntegrationsService IntegrationsService

magicbell-swift-user-client

enums

extensions

APIProtocol

protocols

APIProtocol

structs

@magicbell/project-client

models

services

BroadcastsService ChannelsService EventsService IntegrationsService JwtService

@magicbell/user-client

models

services

ChannelsService IntegrationsService

API

Overview Authentication V1 API Reference OpenAPI Spec

Delivery Channels

Overview Smart Delivery

Notification Inbox

Overview HMAC Authentication

React

React Native

Getting Started Implement mobile push notifications

Browser

Change default font Change default images Notify users for new notifications

Angular

Quick Start

Vue

Quick Start

Overview Amazon SES Mailgun Ping Postmark Sendgrid

Web Push

Mobile Push

Android (FCM)iOS (APNs)

Slack

MagicBell Slack Apps Create your own app Slack Provider Overrides (and Blocks)

SMS

Twilio

Topic & Subscriptions

Overview Topics Subscriptions

Notification Primitives

Broadcast Category Channel Token Channel

Notification Rendering

Channel Templates Email Layouts Override content

Guides

Migrations

Migrating to POST /broadcasts Upgrade @magicbell/webpush to v2

Unread

Properties

Name	Type	Required
backgroundColor	String	✅
textColor	String	✅
hover	UnreadHover	❌
state	UnreadState	❌