Developer Documentation

Build workflows that work.

Technical reference for the WORKWAY SDK, CLI, and integrations. Everything you need to build, test, and deploy.

Your Path to Publishing

Local development is available to everyone. Publishing to the marketplace requires completing the developer journey.

Step 1

Learn

Complete learning paths at learn.workway.co

Step 2

Apply

Join the developer waitlist

Step 3

Get Approved

We accept 10 developers at a time

Step 4

Publish

Ship workflows to the marketplace

Available Now (No Approval)

  • workway workflow initScaffold workflows
  • workway workflow devLocal development
  • workway workflow testTest with mocks
  • workway workflow runExecute locally

After Approval

  • workway workflow publishPublish to marketplace
  • Production OAuth credentials
  • BYOO (Bring Your Own OAuth)
  • Stripe Connect for earnings

Quick Reference

Essential commands and patterns at a glance

CLI Reference

Commands for creating, testing, and publishing workflows

workway workflow initScaffold a new workflow project
workway workflow devLocal development with hot reload
workway workflow testRun tests with mock integrations
workway workflow publishPublish to marketplace (requires approval)

SDK Reference

Core functions and types for building workflows

defineWorkflow()Define a complete workflow
integrations[]Declare OAuth integrations
trigger: {}Configure webhook, cron, or manual
execute()Implement workflow logic
workflow.ts
TypeScript
import { defineWorkflow } from '@workway/sdk';
import { zoom, notion } from '@workway/integrations';

export default defineWorkflow({
  name: 'Meeting Notes',
  description: 'Auto-sync meeting recordings to Notion',
  
  integrations: [zoom, notion],
  
  trigger: {
    type: 'webhook',
    event: 'zoom.recording.completed',
  },
  
  async execute({ data, integrations, ai }) {
    const transcript = await integrations.zoom.getTranscript(data.recordingId);
    const summary = await ai.summarize(transcript);
    
    return integrations.notion.createPage({
      title: data.meetingTopic,
      content: summary,
    });
  },
});

Core Concepts

Understanding WORKWAY architecture

Workflows

Self-contained TypeScript modules that define automation logic with integrations, triggers, and execution handlers.

Triggers

Webhooks for real-time events, cron schedules for recurring tasks, or manual execution on demand.

OAuth & Integrations

Pre-built OAuth flows for 40+ services. Users connect once, workflows use forever.

Workers AI

Built-in AI capabilities for summarization, extraction, classification, and generation.

Config Schemas

Type-safe configuration that lets users customize workflows without touching code.

Edge Deployment

Workflows deploy to Cloudflare Workers globally. Sub-100ms latency, zero cold starts.

Ready to start building?

Begin with the learning paths. Developers who complete them are prioritized for approval.