Turbine User Guide Overview
This page indexes the Documentation section of the Turbine User Guide. Product areas inside Documentation are organized by user role and task.
Choose Your Path
I want to⦠| Go to |
|---|---|
Browse documentation by role or task | Sections below on this page |
Use Hero AI (chat, Text to Playbook, models) | Hero AIHero AI (top-level nav) |
Get started quickly | Quickstart OverviewQuickstart Overview |
See examples and troubleshooting | Examples and Troubleshooting (top-level nav) |
Documentation Sections
1. Daily Operations (USER)
Purpose: Learn how to use Turbine for daily tasks
Contents:
- Workspaces β Organize your workspace
- Dashboards β Create and manage dashboards with charts and visualizations
- Application Records β Work with records, search, filter, and bulk operations
- Reports β Create and share reports
- Library β Access content and solutions
Best for: Users who work with data, create dashboards, and manage records daily
2. Orchestration (ADMIN)
Purpose: Build automation with playbooks, connectors, and components
Contents:
- Playbooks β Create, configure, and manage playbooks
- Getting Started β Create your first playbook
- Configuring Playbooks β Triggers, inputs/outputs, management
- Using Actions β Native actions, record actions, flows
- Testing and Debugging β Test and troubleshoot playbooks
- Building Blocks β Connectors, Components, Assets, Webhooks
- Monitoring β Orchestration Health, AI Agents
- Reference β TEDS Reference, Turbine Solutions Interfaces
Best for: Administrators who build automation and integrate systems
3. Applications and Applets (ADMIN)
Purpose: Build custom applications and applets
Contents:
- Getting Started β Overview and management
- Building Applications β Application builder, layout, permissions
- Building Applets β Applet builder and workflow integration
- Widgets β Create custom widgets
- Workflow β Workflow automation
- Calculations β Calculation builders and operators
- Publishing β Share your applications
Best for: Administrators who create custom applications and workflows
4. Administration (ADMIN)
Purpose: Manage system configuration and users
Contents:
- User Management β Users, Groups, Roles
- System Settings β General, Configuration, Settings
- Security and Authentication β SSO, 2FA, Sessions
- Content Management β Library, Git integration
- Monitoring and Dashboards β System dashboards
- Remote Agents β Installation and management
- Tenants β Multi-tenant configuration
- Audit and Compliance β Audit logging
- Branding β Customization
Best for: System administrators who manage Turbine configuration
5. Reference (ALL)
Purpose: Look up Turbine Schema data models and interface contracts
Contents:
- Turbine Schema β Standardized data models used across Turbine solutions
- Working with Turbine SchemaWorking with Turbine Schema β Concepts, best practices, and troubleshooting
- Turbine Schema Reference (Classic SOC)Turbine Schema Reference (Classic SOC) β Alert, Email, Observable, Enrichment, and supporting objects
- Turbine Schema Reference (AI SOC)Turbine Schema Reference (AI SOC) β Extended Alert and Email objects for AI SOC
- Turbine Schema Reference (VRM)Turbine Schema Reference (VRM) β Vulnerability Finding, Asset, and Remediation objects
- Interfaces β Standard input/output contracts for components
- Working with InterfacesWorking with Interfaces β Concepts, best practices, and troubleshooting
- SOC InterfacesSOC Interfaces β 20 Classic SOC interface contracts
- AI SOC InterfacesAI SOC Interfaces β 4 AI SOC interface contracts
- VRM InterfacesVRM Interfaces β 6 VRM interface contracts
Best for: Anyone building components, playbooks, or applications that use standardized data formats
How to Navigate
By Role
- Daily User: Start with Daily Operations OverviewDaily Operations Overview
- Automation Builder: Start with OrchestrationOrchestration
- AI User: Start with Hero AIHero AI
- Application Builder: Start with Applications and AppletsApplications and Applets
- Component Developer: Start with Working with Turbine SchemaWorking with Turbine Schema
- System Admin: Start with Admin Panel OverviewAdmin Panel Overview
By Task
- "I want to create a dashboard" β Creating a New User DashboardCreating a New User Dashboard
- "I need to build a playbook" β How to Create a PlaybookHow to Create a Playbook
- "I want to build a playbook with AI" β Create and Modify Playbooks with Hero AICreate and Modify Playbooks with Hero AI
- "I want to chat with Hero AI" β Hero AI CompanionHero AI Companion
- "I want to create a custom app" β Applications and AppletsApplications and Applets
- "I need to manage users" β UsersUsers
Need help finding something? Use the search function or browse by section above.