This guide walks you through a simple setup for enabling notifications for your mini app
https://api.neynar.com/f/app/<your_client_id>/event
. See the highlighted URL in the image below.
https://your-frame-domain.com/.well-known/farcaster.json
.
Set the Neynar frame events URL as the webhookUrl
to the Frame Config object inside the manifest. Here’s an example manifest
MiniAppProvider
component:
added
is true and notificationDetails
is a valid object, then the client should have called POST to the Neynar frame events webhook URL with the same details.
Neynar will manage all mini app add/remove & notifications enabled/disabled events delivered on this events webhook.
target_fids
parameter is the starting point for all filtering. Pass an empty array for target_fids
to start with the set of all FIDs with notifications enabled for your app, or manually define target_fids
to list specific FIDs.
MiniAppProvider
context provider, you’ll get additional analytics including notification open rates.
How do I determine if the user has already added my Frame?
MiniAppProvider
context provider, you can check the context
object from the useMiniApp()
hook which contains the added
boolean and notificationDetails
object. More details in Frame Core TypesWhat happens if I send a notification via API to a user who has revoked notification permission?
How do I fetch the notification tokens, URLs, and their status?