Skip to content

Docs/fix notification doc #588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Docs/fix notification doc #588

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a231c7d
call out when using neynar
soheimam Oct 28, 2025
5963930
call out when using neynar
soheimam Oct 28, 2025
580d88d
added pre req
soheimam Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions docs/mini-apps/core-concepts/notifications.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,26 @@ If your webhook processes token saving and sends notifications synchronously bef
<Info>
Notification tokens are unique to each client app. This means a user can have separate notification preferences for your Mini App across different clients (e.g., Farcaster, the Base app). Removing your Mini App in one client does not affect its status in other clients.
</Info>

<Warning>
Set the NEYNAR_API_KEY environment variable in your project to avoid webhook verificiation errors. You may apply for a free tier [here](https://dev.neynar.com/)"
</Warning>
</Panel>

## Prerequisites
Copy link
Collaborator

@ericbrown99 ericbrown99 Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see thread https://coinbase.slack.com/archives/C04QU39MT41/p1761681465072679?thread_ts=1761665953.673189&cid=C04QU39MT41


Before implementing notifications, make sure you have a [Neynar API key](https://neynar.com) (free tier available) to verify webhook events from the Base app.

Set the `NEYNAR_API_KEY` environment variable in your project:

```bash .env.local
NEYNAR_API_KEY=your_api_key_here
```

## Implementation
<Steps>
<Step title="Create a webhook server">
Create a webhook server to handle webhook events.

<Info>
Copy link
Collaborator

@ericbrown99 ericbrown99 Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we removing this?

The `data` object returned by `parseWebhookEvent` contains three key fields:
- **`fid`**: The user's FID
- **`appFid`**: The client's FID (the Base app is 309857)
- **`event`**: The event payload with type and notification details

Always use both `fid` and `appFid` together to identify a unique user-client combination.
</Info>

```ts app/api/webhook/route.ts expandable highlight={20-50}

import {
Expand Down