Developer Documentation
Everything you need to build with Chatterfly — from your first embedded workflow to the full REST API. New here? Start with the Introduction to learn the core concepts, then follow the Quickstart.
Quickstart
Put a live workflow on a web page in about five minutes — no backend code required.
Getting started
Embedding
Platform
Workflows & DSL
How workflow definitions are structured: node types, branching, template variables, surfaces, and validation.
Surfaces & Transports
How participants communicate: transport families (widget, phone, messaging, meeting), voice styles (push-to-talk, continuous, live), triggers vs. surfaces, and the support matrix.
Input Types & Variants
Interactive showcase of every built-in input type — Boolean yes/no, NPS & emoji ratings, currency amounts, address capture, and more.
Authentication & API Keys
The three credential types — API keys, participant tokens, and dashboard sessions — and when to use each.
REST API Reference
Every public endpoint: start runs, poll status, fetch messages, stream events over WebSocket, and mint participant tokens.
Triggers & Webhooks
Start runs automatically on a schedule (cron) or from external events (inbound webhooks), and get notified with event hooks.
Connections
Outbound credentialed links your workflows call: REST APIs, OpenAPI imports, MCP servers, AI providers, and messaging accounts. How they differ from surfaces, fulfillment modes, and tool naming.