Get Buidling!
This section covers everything you will require from Push SDK to create any functionality or features related to Push Notification.
Get Started
Push Notification enables web3 native notification alerts between wallets. To do so, you will be using Push SDK API that will abstract away the complexity of authentication, encryption, signing, sending and receiving of notifications.
Initialize User
Before you can start sending notifications, or receiving notifications from your preferred protocol, you will need to initialize a user or re-authenticate the user. To do so you will use PushAPI.initialize call from @pushprotocol/restapi package.
Manage User
These APIs are useful when you want to manage the Push User profile. This includes changing profile name, avatar, preferences or encrytion algorithms.
Create Channel
This API is useful for creating a channel, which is the first step for sending a notification on Push Protocol.
Channel Settings
This section covers APIs related to creation of channel setting.
Channel Delegates
This section covers all APIs related to managing channel delegate including add / remove and get list of all delegates.
Manage Channel
This section covers all APIs related to managing channel including adding settings, getting and updating channel info, etc.
Fetch Subscriptions
These APIs are useful for fetching list of all channels subscribed by a user and their settings (if any).
Manage Subscriptions
These APIs are useful for managing subscriptions for specific channels including subscribing to a channel, indicating settings for a channel or unsubscribing from a channel.
Fetch Notifications
These APIs are useful for fetching list of all notification (inbox or spam) of a user in a paginated manner.
Types of Notification
Before sending notifications, it's important to learn about their types to help in choosing what notifications you want to send and when.
Send Notification
This section covers all APIs related to sending notifications from a created channel.
Send Notification (via Smart Contract)
Push contracts are designed to act as a communication middleware for your smart contracts which ensures that even smart contracts can communicate with the wallet addresses (ie: web3 users).
Notification Styling
Designing rich notification for Push closely follows the markdown standards. Below is a live example of what is possible with push notifications currently via Push Protocol.
Stream Notifications
These APIs enable you to receive notifications ( inbox or spam ) in real time without polling the API. Push notification achieves this by the use of sockets.
Testing Notifications
This section explores various ways by which you can test your notifications.
Integrating Notifications
This section explores how to integrate notifications on your dApp, mobile app, crypto wallet or on any other frontend.