Skip to main content

Installation

Requirements: Node.js 18+ (uses native fetch). Also works in modern browsers, Cloudflare Workers, Vercel Edge, and Deno.

Two clients, two credentials

The SDK exports two separate clients, each scoped to a different credential and purpose: The separation is intentional. Your API key lives in your production services and travels with every event. Keeping it separate from your client secret means a leaked API key can only ingest events — it can’t read your data, modify schemas, or touch other apps.

Quick example

Features

  • Zero dependencies — uses native fetch, no extra packages to audit
  • Dual CJS + ESM — works with require() and import equally
  • Full TypeScript types — all inputs and responses are typed; no any leakage
  • Typed error hierarchy — catch VelaNotFoundError, VelaValidationError, etc. specifically
  • Batch ingestion — send up to 100 events in one request

Next steps

Ingest Client

Single and batch event ingestion, event fields, levels.

Management Client

Apps, schemas, notification rules — all resource methods.

Error Handling

Typed exceptions, network errors, retry guidance.

Installation

Setup, credentials, edge runtime support.