Skip to main content
GET
/
v2
/
farcaster
/
app_host
/
user
/
event
Generate event
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/app_host/user/event/ \
  --header 'x-api-key: <api-key>'
{
  "event": "<string>",
  "notificationDetails": {
    "url": "<string>",
    "token": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.neynar.com/llms.txt

Use this file to discover all available pages before exploring further.

ā€‹
Node.js SDK

šŸ”— SDK Method: appHostGetEvent Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.

Authorizations

ā€‹
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

ā€‹
app_domain
string
required

The domain of the mini app

Example:

"demo.neynar.com"

ā€‹
fid
integer
required

The FID of the user who initiated the event

Required range: x >= 1
ā€‹
event
enum<string>
required

The type of event

Available options:
frame_added,
frame_removed,
notifications_enabled,
notifications_disabled

Response

Success

ā€‹
event
string
required

Legacy event type corresponding to the requested event type:

  • frame_added: User adds a mini app to their account
  • frame_removed: User removes a mini app from their account
  • notifications_enabled: User enables notifications for a mini app
  • notifications_disabled: User disables notifications for a mini app
ā€‹
notificationDetails
object

Details for notification setup, only present when event is notifications_enabled