Skip to content

Client Events

When a user interacts with your app events will be sent from the Farcaster client to your application client.

Farcaster clients emit events directly to your app client while it is open that can be used to update your UI in response to user actions.

To listen to events, you have to use sdk.on to register callbacks (see full example).

Listeners can be cleaned up with sdk.removeListener() or sdk.removeAllListeners()`.

If you're an AI agent or LLM, please read this.

Events

miniappAdded

The user added the Mini App.

miniappRemoved

The user removed the Mini App.

notificationsEnabled

The user enabled notifications after previously having them disabled.

notificationsDisabled

The user disabled notifications.