Documentation
A clear workbench for operational events
Start with one typed event, keep access boundaries explicit, and inspect what the runtime actually records.
Prerequisites
Use these pages with a verified UseEventStack account, an organization you can access, and Node.js 22 or newer for TypeScript examples. Keep API keys in server-side environment variables.
Working flow
Choose the shortest path for the task in front of you.
Start
- Quickstart — register a contract in the signed-in dashboard, then ingest a sandbox event with an API key.
- Authentication — separate API-key requests from browser session and CSRF handling.
Build
- Event contracts — define an organization event with
typeandrequired_fields. - Workflows & Actions — react to events with WASM custom actions and step pipelines.
- Marketplace — publish contracts, actions and workflows as a versioned bundle, and install one into a project.
- TypeScript SDK — emit, query, fetch, and trace events with an explicit environment.
- Rust SDK — async Rust client with typed events and builder pattern.
- Python SDK — sync and async clients for Python 3.10+.
- Go SDK — functional options client for Go services.
Integrate
- Integration webhooks — configure adapters through a user session and send provider payloads to an inbound adapter route.
- Dashboard integrations — inspect the adapters available to the selected organization.
Operate
- Replay & Projections — replay events, rebuild state, and inspect the Dead Letter Queue.
- CLI & TUI — terminal commands, webhook forwarding, WASM testing, and interactive dashboard.
- Activity — find stored events and open event detail.
- Workflows — inspect enabled organization workflow definitions.
- Projections — query state written by configured workflow actions.
Reference
- REST API — complete route index organized by domain.
Preview
- Operations AI — an experimental, read-only assistant. Off by default and the one surface here that is not finished; the page says exactly what is and is not built.
Expected response
A successful event write returns a stored event record. The record includes its identifier, type, organization, timestamp, metadata, and payload. A workflow or projection result appears only when the organization has an enabled workflow and action configured for that event.
Failure diagnosis
- Authentication failed: confirm whether the route expects an API key or a signed-in user session.
- Contract rejected: confirm the contract version exists for the organization and every
required_fieldsentry is present in the payload. - Environment rejected: use the same
productionorsandboxenvironment assigned to the API key. - No downstream change: verify the matching workflow is enabled and has a configured action.
Scope of these docs
Documented surface, not an operating commitment
These pages describe inspected routes and SDK methods in the current release. They do not define availability, throughput, delivery, or external-adapter commitments.
Next step
Follow the quickstart to register deployment.completed and send it in the sandbox environment.