Skip to main content

Reference

Technical specifications for Hook0. Use this reference when you need exact details about APIs, configuration options, data formats, or error codes.

Quick Navigation​

I want to...Go to
Integrate with the APIAPI Reference
Use a client librarySDKs
Configure Hook0Configuration
Understand an errorError Codes
Define event payloadsEvent Schemas
Use AI assistantsMCP Server
Use the CLICLI Reference

API Reference​

REST API Documentation​

Complete API specification with all endpoints, request/response formats, and authentication details.

Available formats:

  • OpenAPI 3.0 Specification — Machine-readable, import into tools
  • Interactive Swagger UI — Available at /docs on your Hook0 instance

Key endpoints:

ResourceOperations
OrganizationsList, get
ApplicationsCreate, list, get, delete
Event TypesCreate, list, get, delete
SubscriptionsCreate, list, get, update, delete
EventsIngest, list, get
Request AttemptsList, get, retry

SDKs​

Client libraries for integrating Hook0 into your applications.

LanguagePackageStatus
JavaScript/TypeScript@hook0/sdkStable
Rusthook0-clientStable

Configuration​

Configuration Reference​

All environment variables and configuration options for Hook0 server and worker processes.

Data Formats​

Event Schemas​

Standardized payload structures and validation rules for your event types.

Error Codes​

Complete list of HTTP status codes and Hook0-specific error codes with resolution steps.

AI Assistant Integration​

MCP Server for AI Assistants​

Control Hook0 using natural language with Claude, Cursor, Windsurf, or any MCP-compatible AI assistant.

CLI​

CLI Reference​

Command-line interface for managing webhooks, forwarding events locally, and interacting with the Hook0 API.

Key capabilities:

  • Forward webhooks to localhost via WebSocket tunnel (hook0 listen)
  • Send test events with an interactive TUI (hook0 example)
  • Manage events, subscriptions, and applications
  • Replay failed events with filtering