# BuilderBot > BuilderBot es un framework open-source en TypeScript y JavaScript para crear chatbots y agentes conversacionales en WhatsApp (Baileys, Meta Cloud API, Twilio, Venom, WPPConnect), Telegram y otros canales con bases de datos intercambiables (Memory, JSON, MongoDB, MySQL, PostgreSQL). Key facts for coding agents and LLMs: - **Scaffold a new project:** `pnpm create builderbot@latest` or `npm create builderbot@latest` (requires Node.js >= 20 and Git). - **Core package:** `@builderbot/bot` — exports `createBot`, `createFlow`, `createProvider`, `addKeyword`, `addAnswer`, `EVENTS`, `MemoryDB`. - **Three core primitives:** **Flow** (conversation steps built with `addKeyword(...).addAnswer(...).addAction(...)`), **Provider** (channel adapter such as `@builderbot/provider-baileys`, `@builderbot/provider-meta`, `@builderbot/provider-twilio`), and **Database** (`@builderbot/database-memory`, `@builderbot/database-json`, `@builderbot/database-mongo`, `@builderbot/database-mysql`, `@builderbot/database-postgres`). - **Markdown endpoints:** Every documentation page has a clean Markdown counterpart at `.md` (for example, `https://www.builderbot.app/es/quickstart.md`). - **Context bundles:** Curated core context at [https://www.builderbot.app/llms-ctx.txt](https://www.builderbot.app/llms-ctx.txt) and complete documentation corpus at [https://www.builderbot.app/llms-full.txt](https://www.builderbot.app/llms-full.txt). - **Localized indexes:** [English (https://www.builderbot.app/en/llms.txt)](https://www.builderbot.app/en/llms.txt) · [Español (https://www.builderbot.app/es/llms.txt)](https://www.builderbot.app/es/llms.txt) · [Português (https://www.builderbot.app/pt/llms.txt)](https://www.builderbot.app/pt/llms.txt). ## Start here - [Introducción a BuilderBot](https://www.builderbot.app/es/index.md): Con esta biblioteca, puede configurar respuestas automatizadas a preguntas frecuentes, recibir y responder mensajes de forma automatizada y realizar un seguimiento de las interacciones con los clientes. Además, nuestro... - [Quickstart](https://www.builderbot.app/es/quickstart.md): Crear un bot es tan sencillo como ejecutar el siguiente comando y seguir las instrucciones - [Concepts](https://www.builderbot.app/es/concepts.md): En esta guía, hablaremos sobre lo que sucede cuando algo sale mal mientras trabajas con la API. - [Practices](https://www.builderbot.app/es/uses-cases.md): A continuación encontrará diferentes ejemplos que muestran la implementación en diferentes casos de uso. Estos ejemplos han sido compilados en base a la comunidad, siéntete libre de publicar un ejemplo que te guste o... - [Plantillas](https://www.builderbot.app/es/templates.md): Plantillas completas de BuilderBot: un agente con herramientas, ventas por WhatsApp con catálogo, preguntas sobre un PDF o un enlace y soporte con paso a una persona. Un solo archivo para pegar, y corre en tu navegador. - [Playground](https://www.builderbot.app/es/playground.md): Escribe flujos de BuilderBot con addKeyword, addAnswer y addAction y conversa con ellos en el navegador, con el núcleo real de @builderbot/bot. ## Basics - [Features](https://www.builderbot.app/es/add-functions.md): Estas son las funciones más importantes que debes aprender a la hora de crear flujos o interacciones dinámicas con el bot - [Context](https://www.builderbot.app/es/context.md): El objeto "context" es un componente clave dentro del marco que brinda a los desarrolladores acceso a información esencial sobre la interacción continua entre el usuario y el bot. Esta información incluye propiedades... - [Methods](https://www.builderbot.app/es/methods.md): En muchas ocasiones necesitarás compartir datos entre flujos y sin importar si has modularizado tu proyecto en diferentes archivos puedes usar state en la función callback para poder acceder al estado individual de cada... - [Events](https://www.builderbot.app/es/events.md): En ocasiones los usuarios envían mensajes como una imagen, un video o mensajes de ubicación especial, entre otros, para recibir e iniciar una conversación cuando llega un mensaje de este tipo podemos utilizar los... - [Errors](https://www.builderbot.app/es/errors.md): Guía oficial de BuilderBot sobre Errors: ejemplos en TypeScript/JavaScript para bots de WhatsApp y Telegram. ## Databases - [Databases](https://www.builderbot.app/es/databases.md): Así como los proveedores se pueden intercambiar fácilmente entre adaptadores, podemos hacer lo mismo con la base de datos. Ahora lo importante es entender cómo funciona. El objetivo principal de la base de datos dentro... - [Memory](https://www.builderbot.app/es/databases/memory.md): Guía oficial de BuilderBot sobre Memory: ejemplos en TypeScript/JavaScript para bots de WhatsApp y Telegram. - [Supabase Uses Cases](https://www.builderbot.app/en/databases/postgres/uses-cases.md): Connect to your Cloud Supabase database - [Getting Starter](https://www.builderbot.app/en/databases/postgres/uses-cases/uses-cases-supabase.md): Postgres database supports other types of connections as in this case it is Supabase, let's take a quick tour on the Supabase platform to get our database credentials ## Providers - [Providers](https://www.builderbot.app/es/providers.md): Los proveedores se encargan de proporcionar el puente de comunicación entre su bot y whatsapp, telegram o proveedor personalizado. - [baileys](https://www.builderbot.app/es/providers/baileys.md): La plataforma WhatsApp Business permite a medianas y grandes empresas comunicarse con sus clientes a gran escala. Puede iniciar conversaciones con los clientes en solo minutos, enviarles notificaciones de servicio al... - [Blocked Users on BOT](https://www.builderbot.app/en/providers/baileys/blocked-users.md): To check the blocked users on the BOT, you should use the 'fetchBlocklist()' method of the provider. This method has the following signature: - [Delete Bot Message](https://www.builderbot.app/en/providers/baileys/delete-bot-message.md): We can use the sendMessage method to delete a message sent by the bot. This method has the following signature: - [Contacts on BOT](https://www.builderbot.app/en/providers/baileys/delete-on-bot.md): From the adapterProvider, we can utilize the store property to fetch all contacts, store them in a variable, and subsequently display them to the user. This property has the following signature: - [External API Call](https://www.builderbot.app/en/providers/baileys/external-api.md): Firstly, let's create a script named 'getjoke.ts' inside a folder called 'services'. This script will handle the API call to the external service and return the response. Then, in our 'app.ts', we import it, make the... - [Fetch Status](https://www.builderbot.app/en/providers/baileys/fetchStatus.md): This method has the following signature: - [Basic Menu](https://www.builderbot.app/en/providers/baileys/menu.md): Basic menu navigating to two sub-menus with the option to return to the main menu. - [Meta](https://www.builderbot.app/es/providers/meta.md): En esta guía, discutiremos qué hacer cuando algo sale mal mientras trabajamos con la API. - [Meta Uses Cases](https://www.builderbot.app/en/providers/meta/uses-cases.md): There are several features that the default provider does not provide and you can create them along the way - [Providers](https://www.builderbot.app/es/providers/twilio.md): La plataforma WhatsApp Business permite a medianas y grandes empresas comunicarse con sus clientes a gran escala. Puede iniciar conversaciones con los clientes en solo minutos, enviarles notificaciones de servicio al... - [Twilio Uses Cases](https://www.builderbot.app/en/providers/twilio/uses-cases.md): Official BuilderBot guide for Twilio Uses Cases: TypeScript and JavaScript examples for WhatsApp and Telegram chatbots. - [Twilio Setup](https://www.builderbot.app/en/providers/twilio/deploy.md): Twilio is a development platform that enables developers to build cloud communication applications and web systems. Twilio's communication APIs empower businesses to provide the appropriate communication experience for... - [venom](https://www.builderbot.app/es/providers/venom.md): La plataforma WhatsApp Business permite a medianas y grandes empresas comunicarse con sus clientes a gran escala. Puede iniciar conversaciones con los clientes en solo minutos, enviarles notificaciones de servicio al... - [wpp-connect](https://www.builderbot.app/es/providers/wpp-connect.md): La plataforma WhatsApp Business permite a medianas y grandes empresas comunicarse con sus clientes a gran escala. Puede iniciar conversaciones con los clientes en solo minutos, enviarles notificaciones de servicio al... ## Deploy - [Deploying](https://www.builderbot.app/en/deploy.md): Congratulations the time has come to take your project to production and for your convenience there are several ways to achieve this from quite tenic options to other easier strategies. - [Railway](https://www.builderbot.app/en/deploy/railway.md): Railway provides infrastructure primitives with sane defaults to manage secrets, builds, and deploys. So you can start quickly and focus on your product. - [Deploy](https://www.builderbot.app/en/deploy/docker.md): In this guide, we will discuss how to create a Dockerfile and how to deploy your bot. - [VPS (Virtual Private Server)](https://www.builderbot.app/en/deploy/vps.md): Prioritize initiating a connection to your server using SSH or via your chosen cloud provider's preferred method. This initial step is essential to start following this entire tutorial. - [Deploying Your Chatbot with Meta API](https://www.builderbot.app/en/deploy/meta.md): This guide is designed for those who have already followed the official documentation at Meta Provider. It assumes that developer accounts have been created and business and app verification has been completed. ## Recipes & Showcases - [Showcases](https://www.builderbot.app/es/showcases.md): Guía oficial de BuilderBot sobre Showcases: ejemplos en TypeScript/JavaScript para bots de WhatsApp y Telegram. - [Queue](https://www.builderbot.app/es/showcases/queue-limit.md): Implemente colas de mensajes para una mejor administración de recursos - [Modularize](https://www.builderbot.app/es/showcases/modularize.md): Implemente colas de mensajes para una mejor administración de recursos - [Fast Entires](https://www.builderbot.app/es/showcases/fast-entires.md): Implemente colas de mensajes para una mejor administración de recursos - [Idle](https://www.builderbot.app/en/showcases/idle-optional.md): The inactivity of flows in our business logic can become a nuisance, that is why we share the following resources as an alternative solution to this situation. - [Scheduled Reboots](https://www.builderbot.app/en/showcases/docker-pm2.md): When using the free providers we will need to restart the bot to avoid accumulating temporary data that may affect its performance. In that case an easy solution to implement is to schedule restarts, these restarts will... - [Incoming and outgoing messages](https://www.builderbot.app/en/showcases/event-in-out-messages.md): In the example below we show a code which you can execute and observe the messages in the console. The objective is to capture the incoming and outgoing message from the bot. - [Reminder (cron)](https://www.builderbot.app/en/showcases/cron-reminder.md): For this we will need to install some dependencies that will facilitate the work of the scheduled tasks, we will use node-cron below you will find the instructions on how to install install - [Forward conversation to human](https://www.builderbot.app/en/showcases/forward-conversation-to-human.md): In this example let's imagine that the bot number is ADMINNUMBER the idea is that if a user writes me the bot will answer this is correct, but I want to pause the bot for that user, what I do is write to my own number... - [How to use gotoFlow?](https://www.builderbot.app/es/showcases/gotoflow-use.md): GotoFlow es una funcionalidad diseñada para permitir la transición de un flujo a otro dentro de un bot de WhatsApp. Esta capacidad es particularmente útil cuando se tiene lógica de negocios distribuida en diferentes... - [Multiple messages](https://www.builderbot.app/en/showcases/multiple-messages.md): Implement a debounce decorator to prevent the bot from responding multiple times in a short period of time - [How to implement a REST API?](https://www.builderbot.app/es/showcases/api-use.md): En muchas ocasiones necesitamos enviar un mensaje a través de una solicitud HTTP es muy útil para enviar recordatorios o confirmaciones de pedidos. En este caso, cada proveedor implementa una función 'handleCtx' que le... ## Tutorials - [Tutorials](https://www.builderbot.app/en/tutorials.md): Official BuilderBot guide for Tutorials: TypeScript and JavaScript examples for WhatsApp and Telegram chatbots. - [Migrating from bot-whatsapp to builderbot: A Simple Guide](https://www.builderbot.app/en/tutorials/migrate-to-builderbot.md): builderbot is the next evolution of bot-whatsapp, maintaining 99% compatibility while introducing significant improvements. This guide will walk you through the straightforward migration process. - [How to implement a REST API?](https://www.builderbot.app/en/tutorials/api-use.md): In many occasions we need to send a message via HTTP request is very useful to send reminders or order confirmations. In this case each provider implements a handleCtx function which allows you to inject the bot... - [Chatbot with Context](https://www.builderbot.app/en/tutorials/chatbot-with-gemini.md): Implement context for your chatbot solution - [Langchain](https://www.builderbot.app/en/tutorials/langchain.md): When we want something more personality and intelligence in our assistants, the first thing we think about is Openai, what if I tell you that there is a simple way to get the most out of your LLM? ## Plugins - [CONTRIBUTING](https://www.builderbot.app/es/plugins.md): Contribuyendo con nosotros, uniéndote y codificando lado a lado una gran comunidad - [Telegram](https://www.builderbot.app/es/plugins/telegram.md): Telegram es un proveedor fácil de usar, en este artículo aprenderá cómo integrar sus bots de Telegram con la biblioteca. - [Shopify](https://www.builderbot.app/es/plugins/shopify.md): Aprende a implementar tu propio bot de Shopify para ayudar a los clientes de tu tienda y encargarte de las ventas - [OpenAi Plugin](https://www.builderbot.app/es/plugins/agents.md): Instala la librería para hacer uso de OpenAI: - [Builderbot x Langchain](https://www.builderbot.app/en/plugins/langchain.md): This is a series of utilities that use AI based on the langchain framework ## Optional - [Contribute](https://www.builderbot.app/en/contribute.md): Welcome to the BuilderBot Contribution Guide We're glad to have you here. - [Core](https://www.builderbot.app/en/contribute/core.md): Official BuilderBot guide for Core: TypeScript and JavaScript examples for WhatsApp and Telegram chatbots. - [BuilderBot Brand Guidelines and Assets](https://www.builderbot.app/en/resources.md): Brand guidelines and assets for using Instagram logos and resources. - [Contacts](https://www.builderbot.app/es/contacts.md): On this page, we’ll dive into the different contact endpoints you can use to manage contacts programmatically. - [Conversations](https://www.builderbot.app/es/conversations.md): En esta página, profundizaremos en los diferentes puntos finales de conversación que puede usar para administrar conversaciones mediante programación. - [Groups](https://www.builderbot.app/es/groups.md): En esta página, analizaremos los diferentes puntos finales de grupo que puede usar para administrar grupos mediante programación. - [Messages](https://www.builderbot.app/es/messages.md): En esta página, profundizaremos en los diferentes puntos finales de mensajes que puede usar para administrar mensajes mediante programación. - [Webhooks](https://www.builderbot.app/es/webhooks.md): Guía oficial de BuilderBot sobre Webhooks: ejemplos en TypeScript/JavaScript para bots de WhatsApp y Telegram.