DocsDocsDocs
DocsTutorialAPI ReferenceChangelog
Dashboard
DocsDocsDocs
Integrations›Guides
  • Community Discord
  • News & Resources

Get started

  • Welcome to Botpress
  • Quickstart
  • Configure your workspace
    • Preview
    • Edit appearance
    • Add knowledge sources
    • Inspect behaviour
    • Monitor performance
    • Configure Human Handoff
    • Control access to your agent

Studio

  • Introduction
    • Home
      • Introduction
      • Autonomous Node
      • Overview
      • Send Messages
      • Execute Code
      • Tables
      • Set inactivity timeout
      • Webchat
      • Flow Logic
        • Introduction
        • AI Task
        • AI Transition
        • AI Generate Text
      • Capture Information
      • Fixed Schedule
      • Agents
      • Utilities
    • Workflows
      • Overview
      • Add sources
      • Best practices
    • Tables
    • Actions
      • Introduction
      • Summary Agent
      • Personality Agent
      • Policy Agent
      • Translator Agent
      • Knowledge Agent
      • HITL Agent
      • Vision Agent
      • Analytics Agent
    • Hooks
    • Hub
    • Integrations
    • Schemas
    • Versions
    • Bot Settings
    • Find
      • Overview
        • Workflow variables
        • User variables
        • Conversation variables
        • Bot variables
        • Configuration variables
      • Built-in variables
      • Pass between Workflows
      • Use variables in code
    • Triggers
    • Debugger, Logs & JSON
    • Emulator
    • Import & Export
    • Copy to bot
      • Keyboard Shortcuts
      • Commands
      • Studio Preferences
    • Introduction
      • Translate Webchat UI
      • Send reminders to conversations
      • Use different LLM for Autonomous Nodes
      • Track AI spend in a table
      • Send options as a dropdown menu
      • Using code in Studio
      • Event Properties
      • State Management
        • Introduction
        • Preventing Abuse
        • Brand Safety Framework
        • Introduction
        • Raw Conversations
        • Conversation History
        • Streaming Analytics
        • Compiled Bot Analytics
        • Accessing The Autonomous Nodes Thought Process
      • Advanced Starter Template
      • Tips to optimize AI Cost
      • Retention Period
      • Botpress v12

Integrations

  • Introduction
  • Hub
    • Apify (Advanced Website Crawler)
    • Apollo
    • Attio
    • Asana
    • BambooHR
    • Canny
    • Chat
    • Chatwoot
    • Discord
    • Email Notifier
    • GitHub
    • Gmail
    • Google Analytics
    • Google Calendar
    • Google Sheets
      • Setup
      • Measure HITL Response Time
    • HubSpot
    • Hunter
    • Improvement
    • Instagram
    • Intercom
    • Klaviyo
    • Knowledge Base Optimizer
    • Kommo
    • Line
    • Linear
    • LinkedIn
    • Loops
    • MailerLite
    • Messenger and Facebook
    • Mintlify
    • Persat
    • Microsoft Teams
    • Notion
    • Pipedrive
    • Slack
      • Introduction
      • Zendesk Messaging
    • Telegram
    • Trello
    • Twilio
    • Viber
    • Vonage
    • Webhook
    • Workable
      • Setup
        • Botpress to WhatsApp
        • WhatsApp to Botpress
      • Start proactively
      • Start conversation through a webhook
    • Zapier
    • Zendesk
    • Overview
    • Installation
      • Get started
      • Messaging
      • Concepts
      • Publish on Botpress Hub
      • Allow installing with OAuth
      • Use your own LLM
      • Introduction
      • How to implement interfaces
      • Implement HITL
      • Implement File Sync
    • Bots-as-code
    • CLI reference
  1. Integrations
  2. Guides

Chat

The official Chat integration offers an HTTP API to chat with your bot.

Chat API

Check out the Chat API documentation for more information

Cards

Send Custom Event

Send a custom event from the bot to the chat client

inputobject

Triggers

Custom Event

Custom event sent from the chat client to the bot

payloadobject
Previous
Canny
Next
Chatwoot

On this page

Cards
Triggers

Type to search across all docs