WorkApps Developer Documentation

Welcome to the WorkApps developer docs. This portal covers everything you need to build workflow apps on the WorkApps platform.

What is WorkApps?

WorkApps is a platform where teams publish browser-based workflow apps. Apps are static HTML/JS/CSS bundles that store and retrieve structured data through the WorkApps Data API. WorkApps handles authentication, authorization, data storage, and hosting — you only write frontend code.

Quick Start

  1. Getting Started — understand the platform and build your first app
  2. SDK: Records — list, create, update, and delete records
  3. Reference: Field Types — choose the right field type for your data
  4. Example: Task Tracker — a complete working app

SDK Reference (v1)

Page Description
Initialization Loading the SDK, constructor options
Records (CRUD) listRecords, getRecord, createRecord, updateRecord, deleteRecord
Bootstrap & Schema getBootstrap (user, role, limits), getSchema (entity/field definitions)
Bulk Operations bulkCreate, bulkUpdate, bulkDelete
File Uploads & Downloads requestFileUpload, getFileUrl, presigned URL flow
Filtering Filter DSL reference
Pagination Cursor-based pagination + paginateRecords generator
Error Handling Error types, ErrorCode constants, patterns
Maintenance Mode Detection, events, proactive polling
Cancellation & Cleanup AbortSignal, destroy(), TypeScript types

Reference

Page Description
Field Types All 11 field types with validation rules
Roles & Permissions viewer, editor, admin
Limits Rate limits, record counts, file sizes
Inbound Webhooks Accepting external data via token URL

Guides

Page Description
Schema Design Naming conventions, best practices
Role-Based UI Show/hide controls by role
Example: Task Tracker Full working app
Example: Contact Directory Search + filter patterns
Example: Inventory Tracker Number fields, boolean filters