Platform Documentation

For user manual, please visit Platform User Manual.

Overview

Liteed Automation Platform is a multi-tenant SaaS hosted at ai.liteed.com. It provides shared building blocks and APIs for services like Chatbot and Advisor.

Core building blocks

Auth & IAM - authentication, organizations, roles, scoped access.
Microservice architecture - independently deployable services communicating via HTTP and events.
Extendable UI framework - UI shell with reusable UI components, widgets, editors, and data grids.
Event Bus - products emit events; handlers react to automate workflows. See Events and Event Handlers.
Secrets Vault - versioned secure storage for API keys and credentials.
Forms - organization scoped custom forms with JSON definition for fields and settings.

Automation tools (SaaS)

Advisor

General guidance and structured recommendations
Team collaboration aid and shared context
Task tracking and progress logs
Strategic goal settings
Real-time advisor chat
Advisor getting started

Chatbot

Website communication and lead capture
Technical support assistance
Sales assistance and qualification
Knowledge base automation with site-aware context
Chatbot getting started

Event handlers

Events are emitted by products and services, for example the chatbot capturing contact details. Handlers subscribe to specific event names and run within your organization scope. See the full technical reference at /docs/platform/events.

Flow

Emit -> a service records an event with name and payload.
Match -> enabled handlers with the same event name are selected.
Execute -> each handler runs with event payload and org context.
Record -> status and result are saved for inspection and retries if configured.

Supported event names

chatbot.widget.provideContacts
chatbot.widget.requestCallback
chatbot.widget.customFormSubmit
chatbot.widget.requestLiveAgent

Handler types

httpCall - make an HTTP request pipeline to an external system.
notify - send a notification (email channel).

Config example: httpCall

{
  "notify": {
    "email": [
      "ops@example.com"
    ]
  },
  "auth": {
    "type": "staticBearer",
    "token": "{{secret:orgUuid-crmApiKey}}"
  },
  "defaultHeaders": {
    "Content-Type": "application/json",
    "X-Request-Source": "liteed-platform",
    "X-Org": "{{event.organizationId}}"
  },
  "steps": [
    {
      "kind": "httpRequest",
      "id": "createLead",
      "baseUrl": "https://api.example.com",
      "method": "POST",
      "path": "/intake",
      "headers": {
        "Authorization": "Bearer {{secret:orgUuid-crmApiKey}}"
      },
      "body": {
        "source": "chatbot",
        "contact": {
          "name": "{{event.payload.name}}",
          "email": "{{event.payload.email}}",
          "phone": "{{event.payload.phone}}"
        },
        "meta": {
          "sessionId": "{{context.sessionPublicId}}",
          "appKey": "{{context.appKey}}",
          "timestamp": "{{context.timestamp}}"
        }
      },
      "expectJson": true,
      "saveAs": "leadResp",
      "onStatus": {
        "retryOn": [
          429,
          500,
          502,
          503
        ],
        "maxRetries": 3,
        "backoffMs": 1000
      }
    },
    {
      "kind": "assign",
      "id": "extractId",
      "saveAs": "leadId",
      "value": {
        "from": "step",
        "stepId": "leadResp",
        "path": "body.id"
      }
    }
  ],
  "exports": [
    {
      "name": "externalId",
      "from": {
        "from": "step",
        "stepId": "leadResp",
        "path": "body.id"
      }
    }
  ]
}

Secret resolution: {{secret:orgUuid-crmApiKey}} is resolved from Secrets Vault at execution time and injected server side. Secrets are never exposed to the client.

Config example: notify

{
  "notify": {
    "email": [
      "sales@example.com",
      "support@example.com"
    ]
  }
}

Using Secrets Vault in handlers

Store credentials in Secrets Vault with a unique secretId.
Reference them with {{secret:orgUuid-secretId}} in handler config.
Values are injected only during execution and are not logged.

Validation and logging

Configs must be valid JSON. Invalid configs are rejected.
Executions record status and response metadata for troubleshooting.

Forms

The Form table stores custom forms per organization. Each record contains a display name and two JSON columns: fields (structure) and settings (behavior).

organizationId - owner organization of the form.
name - human readable name shown in the UI.
fields - JSON describing what inputs the form renders.
settings - JSON describing submit behavior and messages.

Fields JSON structure

The fields JSON uses a versioned envelope and an array of fields. The JSON below is an example. The reference after the example describes each field and accepted values.

{
  "version": 1,
  "fields": [
    {
      "id": "name",
      "label": "Name",
      "type": "text",
      "required": true
    },
    {
      "id": "email",
      "label": "Email",
      "type": "email",
      "required": true
    },
    {
      "id": "message",
      "label": "Message",
      "type": "textarea",
      "required": false
    }
  ]
}

Fields JSON reference

version (number, required) Version of the fields schema. Current value is 1.
fields (array, required) List of field definitions. Each item is an object with the properties below.

id (string, required) Stable identifier for the field. Used as a key in payloads. Example: "name", "email", "message".
label (string, required) User facing label shown in the UI. Example: "Name", "Email".
type (string, required) Input type. Currently supported values: "text", "email", "textarea".
required (boolean, required) Whether the user must provide a value before submit.

Settings JSON structure

The settings JSON controls how the form behaves on submit. The JSON below is an example. The reference after the example describes each field and accepted values.

{
  "successMessage": "Thank you for your message. We will get back to you soon."
}

Settings JSON reference

successMessage (string, optional) Text shown to the user after successful submission. Example: "Thank you for your message. We will get back to you soon.".

The examples above show one possible configuration. As long as you respect the reference for field names and accepted values, you can adjust labels and messages to your needs.

Changelog

November 30, 2025

Added Forms service with organization scoped form definitions.
Added Forms section in documentation with JSON structure examples and reference.

November 10, 2025

Added Events log with event handle status.
Added Chatbot Live Agent flow, session handling, and messaging interfaces.

October 28, 2025

Internal Notifications System.
Event Handler Selectors.

October 24, 2025

Event Bus and Event Handlers.
Secrets Vault.