UChat Official

Introduction

Welcome to the Mini App Workshop Series, a comprehensive guide designed to introduce you to the fundamentals of building and understanding mini applications.

This series aims to equip you with the knowledge to create a Mini App V2, a flow-based mini application similar to chatbot flow builders.

Whether you're a beginner or looking to deepen your understanding, this guide will walk you through the core components, functionalities, and setup processes involved in developing a mini app.

Overview of Building a Mini App

1. Creating a Mini App

  • Navigation Path:

    • Access your content via My Contents > My Mini Apps

    • Click on Create First Mini App

  • Choosing the Version:

    • Select Mini App V2 for its flow-based architecture, akin to chatbot flow builders

  • Initiating Creation:

    • Click Create to generate your mini app

  • Post-Creation View:

    • The app appears in your Mini App Overview

    • To modify, press Edit

2. Main Components of the Mini App Builder

Component

Description

Key Features

Flow Builder

Core interface for designing specific flows

Build and customize user interactions

Flow Section

Contains individual flows linked to actions

Each flow corresponds to a specific action

Actions

Define inputs and outputs for flows

Register data exchanges within flows

App Fields

Custom data fields similar to chatbot custom fields

Store user data and other information

Authentication

Manage user verification methods

API key, OAuth 2.0, and other types

Triggers

Automate responses based on events

Native triggers for workspace or chatbot actions

One-Time URLs

Capture additional user data

Forms for data collection

Sources

Provide options for dropdowns

Static (predefined) or Dynamic (API-driven)

Settings

Customize app details

Name, description, logo, cover image, videos

Subscription Management

Handle user subscriptions

Subscribe and unsubscribe requests

Detailed Breakdown of Core Sections

Flow Builder

  • Purpose: To visually design the sequence of interactions within the mini app.

  • Functionality: Drag-and-drop interface to create logical flows.

  • Similarity: Comparable to flow builders used in chatbot development.

Flow Section & Actions

  • Flows: Represent individual user journeys or processes.

  • Actions: Define what happens at each step, including:

    • Inputs: Data received from users or external sources.

    • Outputs: Data sent back or used in subsequent steps.

  • Registration: Inputs and outputs are registered within the flow for seamless data handling.

App Fields

  • Role: Store persistent data related to users or processes.

  • Analogy: Similar to custom fields in chatbot platforms.

  • Usage: Hold information like user preferences, IDs, or other relevant data.

Authentication

  • Types:

    • API Key: Common method for securing requests.

    • OAuth 2.0: For more secure, token-based authentication.

  • Purpose: To ensure secure data exchange and user verification.

  • Implementation: Can be added to requests to external APIs or services.

Triggers

  • Function: Automate actions based on specific events.

  • Types:

    • Native Triggers: Built-in triggers within the workspace.

    • External Triggers: Based on external requests or events.

  • Use Case: Initiate flows when certain conditions are met, such as user actions or external API responses.

One-Time URLs

  • Purpose: To gather additional user data via forms.

  • Application: Embed forms to collect information like contact details, preferences, or feedback.

  • Integration: Data collected can be used within the mini app for personalized experiences.

Sources

  • Static Sources:

    • Provide fixed options in dropdown menus.

    • Example: List of predefined categories or choices.

  • Dynamic Sources:

    • Fetch options from external APIs or requests.

    • Example: List of available products from an e-commerce API.

  • Configuration: Set up within the mini app to dynamically or statically populate dropdowns.

Settings

  • Customization Options:

    • Name: Identify your mini app.

    • Description: Brief overview of its purpose.

    • Logo & Cover Image: Visual branding.

    • YouTube Video: Optional tutorial or demo.

    • Subscription Requests: Manage user subscriptions and unsubscriptions.

Next Steps and Deep Dive

This overview provides a foundational understanding of the Mini App V2 architecture and its key components. In upcoming sessions, we will explore each section in greater depth, including:

  • Building complex flows with the Flow Builder

  • Managing data with app fields

  • Securing your mini app with authentication methods

  • Automating processes with triggers

  • Integrating external data sources

  • Customizing app appearance and user experience

By mastering these elements, you'll be well-equipped to develop robust, flow-based mini applications tailored to your needs.