Doc Updates

Documentation Updates

This page tracks all updates made to the Tadabase documentation. Check back regularly to stay informed about new features, improvements, and clarifications.

---

January 14, 2026

Tadabase REST API - Complete Documentation Created

Updated: January 14, 2026 at 4:00 PM UTC

Article: Tadabase REST API Documentation

What is the Tadabase REST API?

The Tadabase REST API allows developers to programmatically interact with their Tadabase applications. Build custom integrations, automate workflows, sync data with external systems, and create mobile apps - all through a powerful, well-documented API.

Key API Capabilities

• Data Operations: Complete CRUD operations with advanced filtering, sorting, pagination, and batch processing
• Three Authentication Methods: API Keys for server-to-server, Bearer Tokens for user-specific operations, Magic Links for passwordless auth
• User Authentication (v1.1): Login, logout, token management, and magic link generation
• Advanced Features: Formula execution, webhooks, tasks, automations, imports/exports, PDF generation
• Rate Limiting: 100 requests/minute, 10,000 requests/day with clear header feedback
• Comprehensive Filtering: 10+ operators including equals, contains, greater than, is blank, and more
• Webhooks: Real-time event notifications with automatic retries and signature verification
• Tasks & Automations: Trigger and monitor background processes via API

What's Documented

• Getting Started: API key generation, required headers, base URL structure
• Authentication Guide: All three authentication methods with code examples
• Data Operations: List, get, create, update, delete records with 20+ examples
• Advanced Filtering: Complete operator reference with query parameter examples
• Batch Operations: Update and delete multiple records efficiently
• User Authentication v1.1: Login, logout, token status, magic links
• Tables & Fields API: Get schema information and field metadata
• Tasks API: List, run, monitor, and terminate tasks
• Automations API: Manage automation configurations and view execution logs
• Webhooks API: Subscribe, unsubscribe, payload format, signature verification
• Formulas & Equations: Trigger recalculations with control headers
• Imports & Exports: CSV imports, multi-format exports with job tracking
• PDF Generation: Create PDFs from templates with dynamic data
• Pages & Components: Access page structure and component data
• Field Types Reference: 15+ field types with format examples
• Advanced Features: Caching, pagination, validation, CORS configuration
• Error Handling: All HTTP status codes with error response formats
• Best Practices: Security, performance, data integrity, and monitoring guidelines

API Endpoints Documented

• Data Operations: 5 core endpoints + filtering, sorting, pagination
• User Authentication: 4 endpoints (login, logout, status, magic links)
• Tables & Fields: 6 endpoints for schema information
• Tasks: 5 endpoints (list, run, status, history, terminate)
• Automations: 4 endpoints (list, details, logs, toggle)
• Webhooks: 3 endpoints (subscribe, unsubscribe, list)
• Formulas: 2 endpoints (update formula, update equation)
• Imports/Exports: 4 endpoints (import, export, status checks)
• PDF Generation: 2 endpoints (generate, download)
• Pages/Components: 3 endpoints (list pages, get components, component data)
• Total: 60+ endpoints fully documented

Code Examples

The documentation includes 80+ ready-to-use code examples covering:

• Authentication: Setting up API keys and Bearer tokens
• CRUD Operations: Complete examples for create, read, update, delete
• Advanced Queries: Complex filtering with multiple conditions
• Batch Processing: Updating hundreds of records efficiently
• Webhook Integration: Setting up event listeners and verifying signatures
• Error Handling: Proper retry logic and error recovery
• Best Practices: Security, performance optimization, and monitoring

API Versions

Technical Implementation Details

• Framework: Laravel (PHP) with Redis caching
• Rate Limiting: Redis-based with per-minute and per-day tracking
• Authentication: Custom middleware with JWT support
• Queue System: Background jobs for imports, exports, webhooks
• Database: MySQL with optimized indexes
• Caching: Redis for app config, rate limits, authentication tokens

Documentation Statistics

• Content Created: 1,745 lines of comprehensive documentation
• Previous State: Single placeholder line
• Content Increase: 17,350% more comprehensive
• Major Sections: 19 sections with 50+ subsections
• Code Examples: 80+ ready-to-use examples
• Reference Tables: 15+ tables for quick reference
• Endpoints Documented: 60+ public API endpoints
• Callout Boxes: 10+ warnings, tips, and best practices

Why This Matters

The Tadabase REST API is one of the most powerful features for developers, but it was severely under-documented. With this comprehensive update, you now have:

• Self-Service Integration: Build custom integrations without support tickets
• Faster Development: Copy-paste code examples accelerate development
• Better Understanding: Technical details help optimize API usage
• Reduced Errors: Comprehensive error handling prevents common mistakes
• Advanced Features: Discover powerful features like webhooks, tasks, and batch operations
• Best Practices: Learn security, performance, and data integrity guidelines

---

Backups and Restores - Major Documentation Update

Updated: January 14, 2026 at 2:45 PM UTC

Article: Backing Up and Restoring Your App

New Features Documented

• Staged Restore (Temporary Restore): A brand new feature that allows you to safely test backups in an isolated environment before making them live. This is perfect for previewing old data or verifying backups without affecting your production app.
  • Three-phase process: Preparation, Activation, and Deactivation
  • Real-time status updates with automatic page refreshing
  • Complete safety - your live data is never affected while testing
  • Easy activation and deactivation with one click

Major Improvements

• Added critical safety warnings: Standard restores are destructive and cannot be undone. We now clearly warn users to create a fresh backup before restoring.
• Complete backup process details: Step-by-step explanation of what happens during a backup, including MySQL dumps, S3 uploads, and metadata recording.
• Restore process transparency: Detailed information about what happens during restore operations, including timing and impact.
• What gets backed up: Comprehensive list of all system tables, custom data, relationships, and optional logs included in backups.
• Email notifications: Documentation of all email notifications you'll receive during backup and restore operations.
• Backup retention: Information about automatic backup cleanup based on your subscription plan.
• Troubleshooting guide: Common issues and how to resolve them.
• Plan requirements: Clear explanation of which features require which subscription plan permissions.

Content Fixes

• Fixed multiple spelling and grammar errors
• Corrected technical terminology
• Improved clarity and readability throughout
• Added proper formatting and structure

Why This Matters

The previous documentation was very basic and didn't explain many critical aspects of the backup system. With this update, you now have:

• Complete understanding of backup and restore operations
• Knowledge of the new Staged Restore feature for safe testing
• Clear warnings about destructive operations
• Detailed troubleshooting information
• Transparency about what data is backed up and how

Documentation Quality

• Content Increase: 788% more comprehensive content
• Sections Added: 7 brand new sections covering advanced features
• Safety Focus: Added critical warnings and best practices
• User-Friendly: Clear, step-by-step instructions with context

---

Enterprise Search - Complete Documentation Created

Updated: January 14, 2026 at 3:30 PM UTC

Article: Enterprise Search

What is Enterprise Search?

Enterprise Search is an advanced search component that provides a powerful query builder interface for creating complex search queries. It's the professional-grade alternative to standard search, offering:

• Advanced Query Builder: Create complex search queries with multiple groups, AND/OR logic at field and group levels
• Saved Searches: Save frequently used queries for instant reuse, stored per user in your database
• 5 Themes: Professional themes (Minimal, Modern, Classic, Material, Bold)
• 7 Color Styles: Light, Royal Blue, Cerise, Sea Green, Burning Orange, Ultramarine, Dark
• 5 Layouts: Default, Layout 2, Slip Popup, Sidebar Drawer, Interpretation Bottom
• Optional Fields: Dynamically add/remove search fields as needed
• Field Bypass: Temporarily disable fields with visual indicator
• Query Preview: See your search logic visualized before executing

What's Documented

• Complete Setup Guide: 4-step process from adding component to configuring themes
• User Guide: Building basic queries, complex queries, managing saved searches
• Search Examples: 4 practical examples from simple to complex grouped queries
• Configuration Reference: All settings, themes, layouts, and options explained
• Comparison Table: Enterprise Search vs. Standard Search feature comparison
• Technical Details: Database structure, storage format, API endpoints
• Troubleshooting: Common issues and solutions
• Best Practices: Search design, user experience, and performance tips

Key Capabilities

• Multiple Condition Groups: Build queries like "(California AND Premium) OR (New York AND Orders > 1000)"
• Field-Level Control: Each field can have its own operators and logic
• Persistent Storage: Saved searches stored in database table app_{appId}_saved_searches
• Join Field Support: Search across related tables with join field filtering
• 175+ Theme Combinations: 5 themes × 7 colors × 5 layouts

Documentation Statistics

• Content Created: 372 lines of comprehensive documentation
• Previous State: Single placeholder line
• Sections Added: 19 major sections including examples, troubleshooting, and best practices
• Premium Feature: Requires subscription plan with Enterprise Search enabled

---

Universal Component - Complete Documentation Created

Updated: January 14, 2026 at 3:30 PM UTC

Article: Universal Component

What are Universal Components?

Universal Components are a modern, flexible system for displaying and managing data using pre-built, professionally designed templates. Instead of building components from scratch, you start with ready-to-use templates and customize them to your needs.

12 Component Types Documented

Complete documentation for all component categories:

• Data Display: Table, List, Card, Detail, Accordion
• Interactive: Kanban, Calendar, Timeline, Maps
• Analysis: Chart, Pivot Table

Revolutionary Features

• Pre-built Templates: Professional designs ready to use - no coding required
• 60+ Field Types: Extensive configuration options including filters, pipes, and display rules
• Version Management: Built-in versioning with update notifications and change notes
• Multi-Component Bundles: Coordinated components (e.g., Table + Detail) that work together
• Theme System: Multiple themes, color variants, and form themes
• Display Rules: JavaScript expressions for conditional field visibility
• Owner-Based Access: Share components with specific users
• Responsive Design: Preview on Desktop, Tablet, and Mobile

What's Documented

• Complete Setup Guide: From library browsing to page deployment
• Configuration System: Tabs, sections, fields hierarchy explained
• 60+ Field Types: Every field type documented with examples
• Display Rules: Conditional visibility with JavaScript expressions
• Multi-Component Bundles: How coordinated components work together
• Version Management: Applying updates, reverting to original
• Theme Customization: Component themes, form themes, custom CSS
• Special Features: Inline editing, drag-drop, calendar, charts, search integration
• Owner-Based Access: Sharing components with specific users
• Responsive Design: Multi-device previews and screen modes
• Best Practices: Choosing components, configuration tips, performance, maintenance
• Comparison Table: Universal vs. Standard Components
• Troubleshooting: 5 common scenarios with solutions
• Technical Details: Database structure, APIs, rendering system

Key Capabilities

• Inline Editing: Edit table records directly without opening forms
• Drag and Drop: Reorder records with visual drag-drop interface
• Search Integration: Components listen to Enterprise Search and standard search
• Lazy Loading: onlyLoadAfterSearch setting for performance
• Calendar Views: Month, week, day views with drag-to-reschedule
• Chart Types: Bar, Line, Pie, Doughnut, Area with aggregations
• Pivot Tables: Cross-tabulation analysis
• Maps: Geographic data visualization

The Time-Saving Advantage

Documentation Statistics

• Content Created: 555 lines of comprehensive documentation
• Previous State: Single placeholder line
• Sections Added: 25 major sections with extensive detail
• Component Types: All 12 types fully documented
• Field Types: 60+ configuration field types explained
• API Endpoints: 7 endpoints documented
• Premium Feature: Requires subscription plan with Universal Components enabled

---

How to Use This Page

This page is updated whenever we make significant improvements to the Tadabase documentation. Each update includes:

• Date and time of the update
• Article link to the updated documentation
• Summary of what changed and why
• Impact on your understanding and use of features

We recommend checking this page regularly or bookmarking it to stay informed about documentation improvements that might help you use Tadabase more effectively.