DOCSEARCHbyAlgolia
Submit Docs

Typebot Documentation

website·Indexed 32 days ago

https://docs.typebot.com/get-started/introduction

Developer documentation for Typebot, featuring a comprehensive API reference for managing typebots, workspaces, folders, and chat sessions. Includes endpoints for analytics, billing, result tracking, and authentication, as well as guides for contributing to the project and creating new blocks.

Tokens
41.3K
Snippets
156
Records
406
Agent score
65%

What's inside Typebot

  1. Overview of Typebot chatbot builder

    Typebot is a fair-source chatbot builder used to create conversational applications and forms for use cases such as lead qualification, customer support, product launches, user onboarding, and AI chats. Bots can be deployed on websites or via WhatsApp numbers to collect results in real time.

  3. Overview of PostHog integration in Typebot

    The PostHog block allows you to send events to PostHog and trigger PostHog workflows. Because it utilizes the PostHog Node.js library, events are sent server-side, ensuring compatibility with non-web browser devices.

  4. Manage Typebot service credentials

    Credentials in Typebot are used to securely connect the platform to external services. They are managed via the Credentials tab located within the Settings & Members menu. Credentials are categorized into two scopes:

    1. User Credentials: Associated with a specific user. Only that user can utilize these credentials. This is ideal for services requiring individual user preference settings.
    2. Workspace Credentials: Associated with a workspace and accessible to all members of that workspace. By default, any new credential created within a bot is set as a workspace credential.

  5. View and analyze user results in Typebot

    After publishing a bot, user responses are collected in the Results tab. Typebot captures answers in real-time as users fill them; therefore, partially completed conversations are recorded. This behavior allows developers to identify where users drop off in the conversation flow to improve bot conversion.

  6. Send HTTP requests to 3rd party services in Typebot

    The HTTP Request block allows you to send information from a bot to an external service or fetch data from an API to be used within the bot's flow. You can configure the URL, HTTP method, and parameters based on the 3rd party service's API documentation.

  8. Understand Typebot block categories and structure

    Typebot chats are constructed using atomic building blocks that are chained together to create conversation flows. All blocks must be contained within groups, which can be assigned titles. Blocks are categorized by their function:

    • Bubbles: Used to display information to the user.
    • Inputs: Used to request information from the user; these blocks pause the conversation until the user provides a response.
    • Logic: Used for background operations that are invisible to the end-user.
    • Integrations: Used to trigger operations in external services.

  9. Use the Jump block to navigate between flow blocks

    The Jump block in Typebot allows you to redirect the conversation flow to a specific block. This is used to organize complex flows, avoid repetitive block sequences, and keep the editor workspace clean by jumping to existing logic instead of duplicating it.

  10. Create a carousel using the Cards input block

    The Cards input block allows you to display a list of cards in a carousel format. Each individual card can be configured to include an image, a title, a description, and multiple buttons for user interaction.

  11. Integrate Zendesk Messaging into Typebot

    The Zendesk Chat block allows you to open a Zendesk Messaging live chat window within your bot, enabling users to communicate directly with a Zendesk agent. This integration is only compatible with web clients.

  12. Deploy Typebot Self-Hosted Architecture

    To self-host Typebot, you must deploy two separate Next.js applications:

    1. The Builder: The interface used to create and configure your typebots.
    2. The Viewer: The interface where end-users interact with and answer the typebots.