Getting Started

To build a Mini App for Towns, follow the Farcaster Getting Started guide. Once you’ve built your Mini App, you can share it in Towns in two ways:

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'
  }]
})

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

​Sharing Mini Apps in Towns