This inbox dashboard can be used for managing conversations and users of your Botpress bot. It uses the official API (in Beta still) and Typescript client.
- List conversations
- List messages of a conversation
- List users of a conversation
- Show details of conversation (tags and created/updated dates)
- Send a new message to conversation
- Delete conversation
- ☑️ Prerequisites: you need to have Node.js installed and access to a command line app (Terminal/Power Shell/Command Prompt)
- ⬇️ Download this project folder and extract it
- 🖥️ Right click on the folder and open it on the , the active path should look like below (unless you moved it)
- ⚙️ Copy this command -
npm install && npm run start- then paste in the Terminal and press Enter to run the app - 📝 You are going to see a screen asking for your token and for the bot URL (these are saved only locally on your PC)
- 🧑💻 Go to Botpress Dashboard, click on your avatar, and go to Personal Access Tokens
- 🗝️ Create a new token called 'inbox-dashboard' for example, and paste it in the app
- 🔗 Still in the dashboard, click on the desired bot on the list and then copy and paste the URL in the app
- ✅ You're done!
- 🤖 In order to send messages as the bot, the bot must have sent an automated message before (from Botpress Studio)
- 🌐 You can use this project on your localhost only (it works perfectly), or you could host it for free on a platform like Vercel/Netlify, in which case you would need to restrict access with native authentication from the platform (easier), or using JWT/Cookies.
- Export single and multiple conversations
- Select multiple conversations to delete
- Create conversation
- Sort conversations by last message
- Show user name in the conversation list
- Delete user
- Responsive style for mobile
- Authentication
- Better styling
- Load conversations and messages on scroll
- Get the bot id as user automatically
- Prompt the user for token and ids instead of using .env
This project makes use of the following libraries:
- React.js v18.2 - app structure
- Vite.js v3.1 - app build
- Botpress Client v0.1.1 - requests to the botpress API
- Date-fns v2.30 - date formatting
- Typescript v4.8 - typings and interfaces
- TailwindCSS v3.1 - styling
- React Router Dom v6.11 - routing
- CryptoJS - encrypting keys
We welcome contributions from the community, so feel free to create issues and open pull requests. As an open-source project, we value your help and feedback in making this project better.
Happy contributing and bot-building!
This project is licensed under the MIT License. You are free to use, modify, and distribute it as per the terms of the license. You can also fork the project and customize it to suit your specific use case, whether you choose to keep it open source or not.
This project is an independent effort and is not affiliated with Botpress in any way. It utilizes the public API provided by the platform to list and manage conversations. Any misuse of this application is solely the responsibility of the user. The creators and contributors of this project disclaim any liability for any damages or issues arising from the use or misuse of this project.