Skip to main content

​
Install

npm install @vela/sdk

​
Requirements

  • Node.js 18+ (uses native fetch)
  • Works in all modern browsers
  • Compatible with edge runtimes (Cloudflare Workers, Vercel Edge, Deno)

​
Set up credentials

# For management operations (apps, schemas, rules)
export VELA_CLIENT_SECRET="vela_cs_..."

# For event ingestion
export VELA_API_KEY="vela_live_..."
Get both credentials from the Vela dashboard. See the credentials guide for details.

​
Verify the installation

import { VelaManagementClient } from '@vela/sdk';

const client = new VelaManagementClient(process.env.VELA_CLIENT_SECRET);
const apps = await client.apps.list();
console.log(`Connected! Found ${apps.length} app(s).`);