Searching ReadMe in the Intercom Messenger
Let your users search your ReadMe docs directly from the Intercom Messenger widget.
The ReadMe Search Intercom Messenger app lets end users search your public ReadMe hub directly from inside the Intercom Messenger widget. When a user types a query, the app returns up to 5 matching docs pages with titles and excerpts — tapping a result opens the full page in a new tab.
Requirements
- A public ReadMe hub (private/gated hubs are not supported at this time)
- An Intercom workspace with the Messenger enabled
Setup
1. Install the ReadMe Search App
Find and install the ReadMe Search app from the Intercom App Store into your Intercom workspace.
2. Connect Your Hub
During installation, you'll be prompted to enter your ReadMe hub URL. You can enter any of the following formats:
- A bare subdomain (e.g.,
acme) - A
.readme.ioURL (e.g.,acme.readme.io) - A custom domain (e.g.,
docs.example.com) - A full URL (e.g.,
https://acme.readme.io/docs/getting-started)
If your hub isn't publicly accessible, you'll see a warning that search results will be empty for visitors. You can still connect and make the hub public later.
3. Add to Messenger Home
Once connected, add the ReadMe Search app to your Messenger home screen in your Intercom dashboard under Messenger Settings > Add apps. Your visitors will then see a "Search the docs" card in the Messenger.
How It Works
When a visitor opens the Intercom Messenger on your site, they'll see the ReadMe Search card on the Messenger home screen. They can type a search query and instantly see up to 5 matching results from your ReadMe documentation. Tapping a result opens the docs page in a new tab.
Limitations
- Public hubs only: The app searches your hub's public search endpoint. If your hub requires authentication, search results will not be available.
- Results cap: Each search returns up to 5 results.
- Query length: Queries are capped at 200 characters.
Need Help?If you still need help, send us an email at [email protected]!
Updated 1 hour ago