BRNZ Platform Documentation

Portal

The top-level organizational unit representing a completely isolated multi-tenant environment. Each portal provides its own branding (logo, favicon, theming), custom domain, independent payment configuration, user group management, and configurable operating modes (free, balance-based, or subscription). Portals enable white-label deployments where each partner or client operates in their own branded space.

Bot

The fundamental operational unit within the platform. Each bot represents an independent project with its own user management system (persons), configurable conversation scenarios and workflows, connected messaging channels, an integrated store with products and payments, and extensibility via tools and services. Bots can be created from templates (blank, ecommerce, etc.) and can be exported/imported for backup and migration.

Person

The unified identity container for all users within a bot ecosystem. A single person record can simultaneously hold multiple role-specific sub-entities: Customer (for shopping, loyalty, order management), Merchant (for product creation and sales management), Crypto Wallet (for blockchain interactions), External Accounts (OAuth integrations with Google, Discord, etc.), and Clients (messaging channel connections). This unified identity model enables cross-channel and cross-role tracking of the same individual.

Feature Description

Administrators can create bots from pre-configured templates (blank canvas, e-commerce, and specialized configurations) or import existing bot configurations. Each bot maintains its own namespace of users, products, scenarios, and settings, operating as a fully independent project within the portal.

Bot configuration includes settings for person attribute schemas (custom fields that define what data is collected about users), AI agent behavior, store parameters, webhook endpoints, multi-language support, role definitions, and team member access. Bots can be cloned, exported as configuration packages, and imported into different portals or environments.

Use Cases

E-Commerce Storefront Bot: A cannabis dispensary deploys a bot connected to their Dutchie POS, with product catalog syncing, order placement via Telegram and WhatsApp, and automated abandoned cart recovery messages through iMessage.

Community Engagement Bot: A fitness brand creates a bot managing their Discord and Telegram communities, with tiered membership access controlled by NFT ownership, automated content posting from RSS feeds, and AI-powered personalized fitness tips via agent broadcasts.

Multi-Channel Customer Support: A medspa uses a Boulevard-integrated bot that handles appointment booking, membership management, and payment recovery across WhatsApp, Instagram DMs, and their website chat widget, with AI agents providing instant responses to common questions.

User Stories

As a platform administrator, I want to create a new bot from an e-commerce template, so that I can quickly set up a new storefront project without configuring everything from scratch.

As a platform administrator, I want to export my bot configuration and import it into a different portal, so that I can replicate successful bot setups across multiple client environments.

As a team member, I want to access only the bots and features assigned to me by the admin, so that I can perform my role without accidentally modifying other projects.

As a bot owner, I want to configure custom person attributes for my bot, so that I can collect industry-specific data points about my users that are relevant to my business.

Feature Description

Account roles include Admin (full platform access, portal management), Subadmin (portal-level access, limited to assigned portals), and User (basic bot creation and management). Within each bot, team members can be added with specific permission sets controlling access to scenarios, store, CRM, broadcasts, settings, and other modules. User groups at the portal level define default permissions and access patterns.

Use Cases

Agency Model: A digital agency manages 20 client bots through a single portal. Each client liaison has Subadmin access to their assigned client portals only, while agency leadership has Admin access across all portals.

Franchise Operations: A franchise network gives each location manager access to their specific bot with permissions for CRM and broadcasts, while corporate retains full administrative control over templates, branding, and global settings.

User Stories

As a portal admin, I want to create user groups with predefined permission sets, so that new team members can be onboarded quickly with the right access level.

As a bot admin, I want to invite a team member with view-only access to analytics, so that my marketing partner can see performance data without modifying bot configuration.

As a subadmin, I want to manage all bots within my assigned portal without seeing other portals, so that I can focus on my client's projects without information overload.

Feature Description

The platform integrates with 15+ messaging providers through a standardized provider interface. Each provider adapter normalizes inbound messages into a common format, handles outbound message composition and delivery, manages provider-specific features (inline keyboards, rich cards, media types), and processes webhooks for message receipt and status updates. New providers can be added by implementing the provider interface.

Use Cases

Omnichannel Retail: A CBD brand maintains consistent customer communication across Instagram DMs for discovery, WhatsApp for order updates, Email for marketing campaigns, and a web widget for live support, all managed from a single bot with unified conversation history per person.

Community-to-Commerce Pipeline: A sports betting platform uses Telegram groups for community discussion, Discord for premium tipping channels, and WhatsApp for individual customer support, with all interactions feeding into a unified CRM for segmentation and targeted broadcasts.

User Stories

As a bot administrator, I want to connect multiple messaging channels to a single bot, so that my customers can reach me on their preferred platform while I manage all conversations in one place.

As a customer, I want to start a conversation on Instagram and continue it on WhatsApp, so that I can switch channels without losing my conversation context or having to repeat myself.

As a bot administrator, I want to view all connected channels and their status in one dashboard, so that I can quickly identify connection issues and ensure all channels are operational.

Feature Description

The broadcast system enables mass messaging operations with sophisticated targeting, scheduling, and content generation capabilities. Four broadcast types are supported:

Manual Broadcasts: Send predefined messages (text, images, files, audio, video, rich cards) to targeted subscriber segments. Optionally trigger a follow-up scenario after delivery. Supports configurable pause intervals between sends for rate limiting.

Scenario Broadcasts: Trigger a specific scenario flow for each targeted subscriber, enabling complex interactive sequences to be initiated at scale. The scenario runs independently for each recipient.

Collection Broadcasts: Automatically distribute content items from a collection (RSS feeds, API sources, social media content, manual entries) to subscribers. Supports auto-posting schedules and content rotation.

Agent Broadcasts: Generate AI-personalized messages for each recipient individually. Uses the bot's configured AI agent with custom prompts and Handlebars template context (client profile data, custom attributes, interaction history) to create unique, relevant messages for every subscriber.

All broadcast types support advanced targeting filters: by messaging provider, tags, labels, gender, subscription status, custom context conditions (with operators including equals, not-equals, greater-than, less-than, regex match, exists/not-exists, date-based ranges), and time-zone-aware delivery (time travel) that sends messages at the recipient's local time.

Use Cases

Personalized Re-Engagement: A medspa uses Agent Broadcasts to send each inactive member a personalized message referencing their last service, membership status, and a tailored offer, resulting in significantly higher re-engagement rates than generic blasts.

Content Distribution: A crypto project uses Collection Broadcasts to automatically share new blog posts (via RSS), market analysis (via API source), and social media highlights (via Telegram channel source) to their community across Discord and Telegram.

Time-Sensitive Promotions: An alcohol DTC brand schedules a Friday evening promotion broadcast with time-travel enabled, ensuring each customer receives the message at 5 PM their local time regardless of timezone.

User Stories

As a marketing manager, I want to create an Agent Broadcast that generates personalized product recommendations for each customer based on their purchase history, so that each customer receives a uniquely relevant message instead of a generic promotional blast.

As a content manager, I want to set up a Collection Broadcast that automatically forwards new RSS feed items to all subscribers, so that our community stays informed about new content without manual intervention.

As a bot administrator, I want to target a broadcast only to subscribers with a specific tag who joined in the last 30 days, so that I can run highly targeted campaigns for specific customer segments.

As a marketing manager, I want to schedule a broadcast for next Tuesday at 10 AM with time-travel enabled, so that every subscriber receives the message at 10 AM in their local timezone for maximum engagement.

Feature Description

Products support both physical and digital goods with comprehensive attribute management. Each product includes base pricing (price, cost/COGS, handling fees), inventory tracking with stock alerts, hierarchical categorization, vendor assignment, dynamic custom attributes defined by configurable schemas, and rich media (images, descriptions). Products can be assigned to merchants for multi-seller marketplace configurations.

Digital product fulfillment supports multiple content types: downloadable files (documents, audio, software), crypto asset distribution (token airdrops, NFT delivery), and structured course/lesson content. Shipping rules are configurable per-product with country-based pricing, quantity-based multipliers, and flat-rate or calculated options.

Products can be bulk-imported and exported via CSV, support slug-based URLs for storefronts, and track view statistics. Margin calculations are automatic based on cost, price, and handling fee configurations.

Use Cases

Cannabis Dispensary Catalog: A dispensary syncs their product catalog from Dutchie POS, with strain categories, THC/CBD percentages as custom attributes, weight-based pricing, and real-time inventory tracking. Customers browse and order through WhatsApp with product cards showing images, descriptions, and pricing.

Digital Course Platform: An educator creates course products with lesson-based content fulfillment, where purchasing a course unlocks a sequence of digital content delivered through the bot. NFT-based access tokens provide permanent proof of purchase on the blockchain.

Marketplace with Multiple Sellers: A platform operator creates a multi-merchant marketplace where each merchant manages their own products, pricing, and inventory. The platform takes a commission on each sale, tracked through the merchant billing system.

User Stories

As a merchant, I want to create a product with custom attributes specific to my industry (e.g., strain type, THC percentage for cannabis), so that my product listings contain all the information my customers need to make a purchase decision.

As a merchant, I want to set up country-based shipping rules with quantity multipliers, so that shipping costs are automatically calculated correctly regardless of destination or order size.

As a bot administrator, I want to bulk import 500 products from a CSV file, so that I can quickly populate my store catalog without manually creating each product.

As a customer, I want to browse products by category through a conversational interface, so that I can discover and purchase products naturally within my preferred messaging app.

Feature Description

The order system manages the complete lifecycle from cart to fulfillment. Orders progress through status stages: New, Pending, Paid, Fulfilled, and Refunded. Each order tracks products with quantities, pricing, shipping costs, merchant assignments, applied discounts, custom notes with configurable labels, file attachments, and comprehensive profit calculations (revenue, net profit, gross profit, margins, transaction fees, COGS, shipping, handling, discounts, taxes).

Orders can be created by customers through the storefront flow or manually by administrators. Both physical fulfillment (with status tracking) and digital delivery (automatic content access upon payment) are supported. Orders can be exported to CSV with flexible filters for reporting and analysis.

Use Cases

Split-Merchant Orders: A customer places a single order containing products from three different merchants. The system automatically calculates per-merchant amounts, applies merchant-specific discount codes, and routes fulfillment tasks to each merchant independently.

Automated Digital Delivery: When a customer purchases a digital product and payment is confirmed, the system automatically triggers digital content delivery (file download link, course access, or crypto asset transfer) without manual intervention.

User Stories

As a customer, I want to apply a discount code at checkout and see the adjusted total before paying, so that I can verify the discount is applied correctly before completing my purchase.

As a merchant, I want to receive instant notifications when a new order is placed for my products, so that I can begin fulfillment immediately to maintain fast delivery times.

As a bot administrator, I want to export all orders from the last quarter with profit calculations, so that I can analyze business performance and identify trends in my sales data.

As a customer, I want to receive automatic digital content delivery after payment confirmation, so that I get immediate access to my purchase without waiting for manual processing.

Feature Description

The platform supports seven payment gateways, each optimized for different use cases and regions:

Recurring payment support enables subscription billing with automatic renewal, failed payment handling, and grace periods. Payment profiles store customer payment preferences securely with encrypted credentials.

Feature Description

The customer management system tracks all commercial interactions within a bot's ecosystem. Customers can register through full login/password flows, guest checkout, social login integration, or referral codes. Each customer profile includes custom attributes (configurable per-bot schema), address book, order history, favorites/wishlist, balance-based billing with transaction ledger, and segment tags.

Customer data can be exported to CSV for external analysis. The system supports both human-managed CRM workflows and automated engagement through scenario triggers, broadcasts, and AI agent interactions.

Feature Description

For marketplace configurations, the merchant system provides dedicated seller accounts with product ownership, sales tracking and analytics, commission-based billing, balance management with transaction history, and order fulfillment workflows. Merchants can create and manage their own products, set pricing, configure shipping rules, and manage discount codes within their scope.

Feature Description

The discount system supports both percentage and fixed-amount discount codes with usage limits (per-code and per-customer), date range restrictions, product/category targeting, merchant-specific scoping, and auto-application rules. Multiple discount codes can be applied to a single order with stacking rules.

The cashback system enables per-product cashback rates that customers can claim through a task-based workflow. Cashback claims go through a verification/approval process, with approved amounts added to customer balances. Transaction history tracks all additions, deductions, and pending claims.

User Stories

As a marketing manager, I want to create a discount code that gives 15% off cannabis products only, limited to 100 uses, valid until the end of the month, so that I can run targeted promotions with precise control over scope and budget.

As a customer, I want to see my accumulated cashback balance and claim rewards, so that I feel rewarded for my purchases and motivated to continue buying.

As a merchant, I want to create merchant-specific discount codes for my products within the marketplace, so that I can run my own promotions independently of the platform operator.

Feature Description

Users can connect blockchain wallets through a secure signature-based verification flow. When a user connects a wallet, the platform generates a unique nonce (anti-replay protection), the user signs the nonce with their private key, the platform verifies the signature on-chain, and upon successful verification, the wallet is linked to the user's person record. Multiple wallets across different blockchains can be linked to a single person, enabling cross-chain portfolio tracking and unified identity management.

Use Cases

Token-Holder Community: A project requires users to connect their wallets and verify NFT ownership to access premium Discord channels. The bot automatically grants and revokes roles based on real-time on-chain verification.

Multi-Chain Portfolio Dashboard: A DeFi community bot shows each user their aggregated holdings across Ethereum, Solana, and Polygon, with price feeds from CoinGecko and DexScreener services.

Feature Description

The NFT Plans system creates subscription tiers that are controlled by blockchain asset ownership rather than traditional payment methods. Administrators define NFT plans specifying which token contract and blockchain network to verify against, and optionally configure Merkle tree allowlists for restricted minting. Users who hold the required NFTs receive automatic access to gated content, channels, or features.

The token-gated access component integrates directly into the scenario builder, enabling conversation flows to check on-chain ownership in real-time and branch accordingly (granting access or presenting purchase options).

User Stories

As a project owner, I want to create an NFT plan that grants premium access to holders of my collection, so that my NFT holders receive exclusive benefits that increase the value of holding my tokens.

As a community member, I want to connect my wallet and automatically receive access to gated channels, so that I can prove my token ownership once and receive ongoing benefits without repeated verification.

As a administrator, I want to set up a Merkle tree allowlist for a restricted NFT mint, so that only approved wallet addresses can mint tokens during the exclusive pre-sale phase.

Feature Description

The crypto asset distribution tool manages token airdrops and NFT distribution campaigns. Administrators can register tokens and NFTs from any supported blockchain, configure distribution strategies (airdrop to all holders, reward for specific actions, purchase-triggered delivery), and track distribution progress. The tool integrates with on-chain indexing services (Helius for Solana, Blockfrost for Cardano, Moralis for EVM chains) to verify transactions and update delivery status.

Use Cases

Loyalty Token Airdrop: A brand airdrops loyalty tokens to their top 1000 customers based on purchase history, with the tokens redeemable for discounts or exclusive products through the bot's store.

NFT-as-Receipt: Each product purchase automatically triggers an NFT mint on Base (low-cost L2), providing customers with an immutable proof-of-purchase that doubles as a collectible and grants access to a holder-only community.

Feature Description

Each bot can configure an AI agent that handles conversational interactions. The agent system supports two provider backends: OpenAI (GPT models with Responses API, DALL-E for image generation) and Anthropic (Claude models with native MCP server integration). Agents are configured with customizable system prompts that define personality, domain knowledge, and behavioral guardrails. Handlebars templating allows system prompts to incorporate dynamic context (user name, attributes, conversation history, bot data).

The conversation memory system maintains message history per-client with configurable context windows (default 10 messages). Agents can operate in both request-response and streaming modes. Streaming responses deliver incremental text, server tool use events, and MCP tool use events to clients in real-time, enabling fluid conversational experiences.

Use Cases

Intelligent Medspa Assistant: A medspa bot configured with a Claude agent that knows the full service menu, pricing, membership tiers, and availability. The agent can answer detailed questions about treatments, recommend services based on customer concerns, and hand off to the appointment booking scenario when the customer is ready.

Crypto Market Analyst: A DeFi community bot with an OpenAI agent connected to MCP servers for CoinGecko and DexScreener, enabling real-time price lookups, market analysis, and portfolio suggestions within the conversation flow.

Autonomous Customer Support: A gray-area brand deploys a Claude agent with MCP access to their product database, order system, and FAQ knowledge base. The agent resolves 80% of customer inquiries without human intervention, escalating complex issues to the team.

User Stories

As a bot administrator, I want to configure an AI agent with a detailed system prompt that reflects my brand voice and product knowledge, so that customer interactions feel personalized and on-brand, even at scale.

As a bot administrator, I want to connect MCP servers to my AI agent for real-time data access, so that the agent can look up live inventory, pricing, and customer data during conversations.

As a customer, I want to ask complex multi-part questions and receive contextually aware responses, so that the AI remembers our conversation context and builds on previous exchanges.

Feature Description

Model Context Protocol (MCP) servers extend AI agent capabilities by providing structured tool access to external systems and data. The platform supports two MCP server types:

Custom MCP Servers: Connect any external MCP-compatible server by specifying a URL, name, description, and optional instructions. Supports bearer token and custom header authorization, tool filtering (allowed tools whitelist), and descriptive instructions that are injected into the AI agent's system prompt.

Service MCP Servers: Automatically generated from installed service adapters that declare MCP capability. When a service supports MCP, it provides a structured interface that the AI agent can use to interact with the service's API through natural language.

Access control is role-based: administrators can restrict which client roles can trigger MCP tools, and clients can have override lists limiting which MCP servers their conversations can access. MCP server credentials (tokens, API keys) are encrypted at rest using AES encryption with per-server salt.

Use Cases

CRM-Connected Support Agent: An MCP server wraps the bot's customer and order APIs, allowing the AI agent to look up customer history, check order status, and initiate returns during a support conversation, all through natural language.

Multi-Service Orchestration: A bot connects MCP servers for Boulevard (appointments), Klaviyo (email marketing), and its own product database, enabling the AI agent to simultaneously check appointment availability, trigger targeted email campaigns, and recommend products.

User Stories

As a bot administrator, I want to add a custom MCP server pointing to my internal API, so that my AI agent can access proprietary business data and tools during customer conversations.

As a bot administrator, I want to restrict MCP server access to specific client roles, so that only premium subscribers can trigger AI-powered actions that consume expensive API calls.

As a developer, I want to deploy a service-based MCP server that automatically exposes my service's capabilities to the AI agent, so that AI integration happens without custom development or prompt engineering.

Feature Description

Beyond conversational agents, the platform integrates AI for content creation across multiple modalities:

Image Generation: OpenAI DALL-E and Midjourney integration for generating product images, marketing visuals, and creative assets. Midjourney tasks are managed through a queue system with progress tracking and callback notifications.

Music Generation: FoxAI integration for generating music and audio content, enabling bots to create custom audio experiences.

Serverless AI Inference: FAL integration provides access to a wide range of AI models for specialized tasks including style transfer, upscaling, background removal, and other computer vision tasks.

Virtual Staging: Specialized AI for real estate applications, generating staged interior images from empty room photos.

Feature Description

The affiliate program tool creates a comprehensive partner ecosystem within any bot. Partners (customers who opt in) receive unique referral codes and discount codes. When a referred customer places an order, the partner earns a configurable reward (fixed amount or percentage, paid in currency, loyalty points, or crypto). The tool also supports loyalty tasks where partners earn points for completing specific activities (social media shares, content creation, event attendance).

Redemption management allows partners to withdraw accumulated rewards when they reach a configurable minimum threshold. The system tracks all transactions with a full audit trail and provides leaderboard integration to gamify partner performance.

User Stories

As a customer, I want to join the affiliate program and receive a unique referral code, so that I can share it with friends and earn rewards when they make purchases.

As a partner, I want to complete loyalty tasks (share on social media, attend events) to earn additional points, so that I can earn rewards beyond just referrals by actively promoting the brand.

As a partner, I want to withdraw my accumulated rewards once I reach the minimum threshold, so that I can convert my promotional efforts into tangible value.

As a bot administrator, I want to configure different reward rates for different product categories, so that high-margin products can offer more generous referral incentives to drive sales.

Feature Description

The cart recovery tool automates re-engagement for customers who abandoned their carts before completing purchase. It connects to the e-commerce platform (native or via Shopify integration), detects abandoned carts, and initiates a configurable sequence of recovery messages through the customer's preferred messaging channel.

Each recovery sequence includes timed message intervals, escalating discount incentives, and configurable content. The tool supports country-based filtering (target specific markets), marketing consent verification, and conversion tracking. Recovery campaigns can be customized with the business name, human-readable sender name, and dynamic discount codes that are automatically applied when the customer returns to checkout.

User Stories

As a e-commerce manager, I want to configure a 3-step cart recovery sequence with escalating discounts, so that abandoned carts are automatically recovered with minimal manual intervention.

As a customer, I want to receive a friendly reminder about items I left in my cart, with a personalized discount offer, so that I feel valued as a customer and have an incentive to complete my purchase.

As a bot administrator, I want to view cart recovery conversion rates and recovered revenue metrics, so that I can optimize my recovery sequences based on real performance data.

Feature Description

The subscription outreach tool automates proactive engagement with subscribers based on their membership status, connecting to external platforms (currently Boulevard for medspas and gyms) to fetch real-time membership data. Two strategies are available:

Low-Engagement Strategy: Targets active members who have not booked appointments recently. Configurable inactivity thresholds (e.g., no booking in 30 days) trigger enrollment into a multi-step message sequence encouraging re-engagement.

Past-Due Strategy: Targets members with overdue payment status. Automatically enrolls them into a payment recovery sequence with reminder messages, escalation, and exit conditions monitored through both periodic checks and platform webhooks.

Each campaign tracks enrollment status (pending, active, completed, success, cancelled) and monitors exit conditions to automatically remove subscribers who take the desired action (booked an appointment or made a payment). This enables MRR recovery tracking and campaign ROI analysis.

Feature Description

The Boulevard integration is a deep e-commerce service connection specifically designed for medspas, salons, and gym businesses. It provides bidirectional sync between the BRNZ bot and Boulevard's business management platform, including client lookup and management, appointment booking and modification, membership status and payment tracking, service menu synchronization, and webhook-driven event processing for real-time updates.

The integration uses Boulevard's authenticated API with HMAC-SHA256 signed tokens for both admin and client-level operations. This enables the bot to perform actions on behalf of both business administrators and individual clients within the Boulevard ecosystem.

Use Cases

Automated Appointment Recovery: The subscription outreach tool connects to Boulevard to identify inactive members, automatically enrolls them in a WhatsApp-based re-engagement campaign, and monitors for successful rebooking through Boulevard webhooks to exit the campaign.

Conversational Booking: A customer messages the medspa bot on Instagram, browses available services (synced from Boulevard), selects a time slot, and completes booking entirely within the chat conversation.

Feature Description

The Shopify integration enables synchronization between a Shopify store and the BRNZ bot ecosystem, including product catalog sync, order management, customer data sync, and webhook processing for real-time event handling. The integration supports Shopify's OAuth authentication flow and provides a dedicated auth handler for seamless connection setup.

Feature Description

ShopLine integration provides an alternative e-commerce platform connection with its own event handling system and data models. The integration supports product sync, order events, and customer management through ShopLine's API, with dedicated event handlers for real-time webhook processing.

Feature Description

Each portal is a fully self-contained environment with configurable branding (logo, favicon, custom logo variants), custom domain mapping, independent operating mode (free, balance-based, or subscription billing), initial balance and threshold settings for balance mode, trial period configuration with feature limits, user registration controls (open or secret-code gated), custom SMTP configuration for branded email delivery, configurable email templates for all system communications, CMS-style content pages, multi-language interface translations, and customizable navigation and module visibility.

Portal-level agent configuration allows setting default AI system prompts that apply to all bots within the portal, establishing consistent AI behavior across the deployment. User and bot schemas can be customized at the portal level, defining what custom attributes are available for all entities within that portal.

Use Cases

White-Label SaaS Platform: A partner deploys the BRNZ platform under their own brand (custom domain, logo, colors) and sells bot creation as a service to their clients. Each client operates within the partner's portal with the partner's branding, while BRNZ infrastructure handles all technical operations.

Enterprise Deployment: A large organization creates a private portal with secret-code gated registration, custom SMTP for branded emails, and subscription-based billing. Internal teams create bots for different departments (marketing, support, sales), all operating under the organization's unified branding.

User Stories

As a portal admin, I want to configure custom branding including logo, favicon, and domain for my portal, so that my clients see my brand throughout their experience, not the underlying platform.

As a portal admin, I want to set up subscription plans with different feature tiers and trial periods, so that I can monetize the platform with clear pricing tiers for different customer segments.

As a portal admin, I want to configure custom SMTP settings and email templates, so that all system emails come from my domain and match my brand's visual identity.

As a portal admin, I want to define custom attribute schemas that apply to all bots in my portal, so that every bot in my portal collects the industry-specific data I need.

Feature Description

Scenarios define automated conversation flows that are triggered by pattern matching on incoming messages. Each scenario consists of a sequence of components (building blocks) connected by flow logic. Scenarios support multi-language configurations, priority ordering (when multiple scenarios match), active/inactive states, and cloning for rapid iteration.

Triggers use pattern matching with support for exact keywords, regular expressions, wildcard patterns, and event-based activation (scenario completion, customer creation, order placement, etc.). When a message matches multiple scenarios, priority ordering determines which executes.

Key Component Details

REST Component: Makes HTTP API calls with configurable method, URL, headers, authentication (Basic, Digest, Bearer), request body (structured or raw), and response processing. URL parameters and request data support dynamic variable substitution from conversation context. Response data can be mapped to conversation variables for use in subsequent components.

Condition Component: Evaluates conditions with operators including equal, not-equal, greater-than, greater-than-or-equal, less-than, less-than-or-equal, regex match, and existence checks. Both the value and target support dynamic context references, enabling data-driven branching.

Agent/Input Component: Collects user input with format validation, stores responses in conversation or person-level variables, and can trigger AI agent processing for natural language understanding.

Decision Tree: Multi-level branching structure that presents sequential questions with button options, creating guided decision paths that narrow down to specific outcomes or recommendations.

Use Cases

Product Recommendation Engine: A scenario uses a Decision Tree to ask about preferences (category, budget, use case), queries the product catalog via the Product component, applies Condition logic to filter results, and presents matching products as Cards with add-to-cart buttons.

Order Support Flow: A scenario triggered by 'order status' keywords uses the Customer component to look up the user, the Order component to retrieve recent orders, a Condition to check order status, and branching REST calls to external shipping APIs for tracking information.

Appointment Booking: A scenario connected to the Boulevard Service component guides the user through service selection, date/time preference, and booking confirmation, with real-time availability checks via the REST component.

User Stories

As a bot administrator, I want to build a multi-step product recommendation flow using the visual editor without writing code, so that I can create sophisticated conversational experiences by connecting components visually.

As a bot administrator, I want to create a scenario that calls my external API and processes the response, so that my bot can integrate with any system through the REST component.

As a bot administrator, I want to clone an existing scenario and modify it for a different use case, so that I can rapidly iterate on successful conversation patterns without starting from scratch.

As a customer, I want to follow a guided decision tree that narrows down exactly what I need, so that I discover the right product through a natural conversational flow rather than browsing a catalog.

User Stories

As a platform administrator, I want to require secret code for new user registration in my portal, so that only authorized individuals can create accounts in my private deployment.

As a customer, I want to log in with my Google account instead of creating a new password, so that I can access the platform quickly without managing another set of credentials.

As a crypto user, I want to authenticate by signing a message with my wallet, so that I can prove my identity without sharing personal information or creating traditional credentials.