API Reference Overview

​

Workflow APIs

• createHook - Create a hook to receive external data
• createWebhook - Create a webhook to receive HTTP requests
• defineHook - Define a typed hook with validation
• sleep - Pause workflow execution for a duration
• fetch - Make HTTP requests from workflows
• getWorkflowMetadata - Get workflow run metadata

​

Step APIs

• getStepMetadata - Get current step metadata
• getWritable - Get a writable stream for the workflow
• getWorkflowMetadata - Get workflow run metadata

​

Error Handling

• FatalError - Throw a non-retryable error
• RetryableError - Throw an error with retry configuration

​

Import Pattern

import {
  createHook,
  createWebhook,
  defineHook,
  sleep,
  fetch,
  getStepMetadata,
  getWorkflowMetadata,
  getWritable,
  FatalError,
  RetryableError,
} from 'workflow';