Sending Notifications
Apps and NFT collections that want to use our notification protocol to interact with their users will receive access to a notification dashboard from which they can send notifications. They will be able to see the number of subscribed keys, their casts, and other general statistics.
Panel URL: https://panel.aptcast.live
Apart from the dashboard, we provide API endpoints that let apps integrate notifications in their own custom business flows.
Broadcast notifications are sent to all keys that are subscribed to the dApp.
Unicast notifications are sent to a single targeted key that is subscribed to the dApp.
Broadcast notifications are not sent right away, they are subjected to review before being sent out to users.
Even unicast notifications will be subject to review while we are in the first few days of beta.
Notification contains
| 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 Key | Y* | For unicast notifications |
Topics
There will be 3 default notification topics. In the future users will have the option to opt out of specific topics. We currently have General, Security, and Transactional.
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.
Last updated
