Onboarding Guide

TwikBot Platform

Overview

The Twikit Platform is the core of TwikBot — the engine that manages all configuration logic, pricing rules, asset libraries, production output, and API communication. It is the central layer that connects the frontend experience to the rendering layer and external systems, and it is where the majority of implementation and setup work takes place.

Partners and agencies interact with the Twikit Platform primarily through http://platform.twikit.com, the web-based management environment where projects are created, configured, and published.


Core Components

Projects

A Project is the top-level container in the Twikit Platform. Each Project represents a single configurable product or product family and contains all of the configuration logic, assets, pricing rules, and output templates associated with it.

Key actions within a Project:

  • Define the product structure and option hierarchy

  • Manage 3D assets and material libraries

  • Set up configuration rules and constraints

  • Configure CPQ pricing logic

  • Define production file output templates

  • Publish the web plugin script for frontend integration

Configuration Engine

The configuration engine manages the logic that governs which options are available, how they interact, and what constitutes a valid configuration. It evaluates rules in real time as a user makes selections, ensuring that the output always reflects a manufacturable, valid product.

Key concepts:

  • Parameters — The individual configurable attributes of a product (e.g. colour, material, size, component)

  • Parameter Groups — Logical groupings of parameters for presentation and navigation purposes

  • Rules — Conditional logic that controls parameter availability, visibility, and value dependencies

  • Constraints — Hard restrictions that prevent invalid combinations from being selected

Asset Management

The Twikit Platform manages the 3D assets and materials that power the visual output of a configurator. Assets are imported, organised, and linked to configuration parameters so that the rendering layer knows what to display for any given configuration state.

Key capabilities:

  • Import and manage 3D model files

  • Define and manage material and texture libraries

  • Link assets to specific parameter values

  • Version and update assets without rebuilding the configuration logic

CPQ & Pricing

Pricing logic is configured directly within the Twikit Platform and evaluated in real time as a configuration is built. The platform supports multiple pricing models and can connect to external pricing sources via the integration layer.

Key capabilities:

  • Rule-based and formula-driven pricing per parameter value

  • Multi-market and multi-currency support

  • Pricing summary output as part of quote and order generation

  • BOM line item generation tied to configuration output

Production Output

The Twikit Platform generates production-ready files upon configuration completion or order submission. Output templates are configured per project and can be adapted to match the requirements of any downstream manufacturing or ERP system.

Key capabilities:

  • Configurable output templates per project

  • Support for multiple output formats

  • Technology-agnostic — output adapts to the client's production environment

  • Triggered via the .order() SDK method or API call

Publishing & Versioning

The Twikit Platform manages the lifecycle of a configurator from development through to live deployment. Projects are versioned, and changes can be tested before being published to the live environment.

Key capabilities:

  • Draft and published states per project version

  • Web plugin script generation on publish

  • Rollback to previous published versions

  • Change history and audit trail


TwikBot Platform

All platform management tasks are performed via http://platform.twikit.com. As a partner or agency, this is where you will spend the majority of your implementation time. Access is role-based, and client accounts can be set up to allow the manufacturer to manage specific aspects of their configuration post-handover.

Key areas of the platform interface:

  • Projects — Create and manage configurator projects

  • Resources — Upload and organise 3D models and materials

  • Rules & Parameters — Define configuration logic

  • Pricing — Set up CPQ rules and pricing tables

  • Output Templates — Configure production file generation

  • Publish — Generate and deploy the web plugin script


Relationship to Other Layers

The Twikit Platform sits at the centre of the architecture, communicating with all other layers:

Frontend Layer  →  Twikit Platform  →  Rendering Layer
                         │
                         ▼
                  External Systems
                (ERP / CRM / eCommerce)

It receives user input from the frontend, instructs the rendering layer to update the 3D output, evaluates configuration and pricing logic, and passes structured data to external systems via the integration layer.


Developer Resources

Resource

Location

Web SDK Reference

Web SDK | Reference

API Documentation

https://api.twikit.com/docs

Projects Setup Guide

Projects | Setup