Skip to main content

Documentation Index

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

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

To build a Mini App for Towns, follow the Farcaster Getting Started guide.

​
Sharing Mini Apps in Towns

Once you’ve built your Mini App, you can share it in Towns in two ways:

​
1. Via Bots

Bots can share Mini Apps as attachments in messages: 
await bot.sendMessage(channelId, "Check out this Mini App!", {
  attachments: [{
    type: 'miniapp',
    url: 'https://your-miniapp.com'
  }]
})

​
2. Via Direct URLs

Users can paste Mini App URLs directly in Towns conversations. The Towns client will automatically render compatible Mini Apps.