Sending Notifications
Last updated
Last updated
Apps that want to use our notification protocol will receive access to a notification dashboard from where they can send notifications. They will be able to see several subscribed public keys, their casts, and other general statistics.
Apart from the dashboard, we provide API endpoints that let apps integrate notifications in their custom business flows.
Apps can send two types of notifications - broadcast and unicast.
Broadcast notifications are sent to all public keys subscribed to the app.
Unicast notifications are sent to a single targeted public key that is subscribed to the dApp.
Broadcast notifications are not sent immediately; they are subject to review before being sent to users.
| Field | Mandatory | Note |
|---|---|---|
Title | Y | |
Body | Y | |
Icon | Y | Only shown on web |
Image | N | Only shown on mobile |
Action URL | N | Only works on web |
Platform | Y | |
Cast time | Y* | For broadcast notifications |
Topic | Y | |
Target Public Key | Y* | For unicast notifications |
There are 3 default Notification Topics, users have options to opt-out of specific topics.
Currently, we have:
General - Used for marketing and general announcements
Security - Used for announcements about security issues
Transactional - Used when targeting specific/single user(s) about some event/transaction, etc.
