# Vela

## Docs

- [Create App](https://docs.velahq.xyz/docs/api-reference/apps/create-app.md): Creates a new app and returns the generated API key. The full API key is **only returned in this response** — store it securely.
- [Get App](https://docs.velahq.xyz/docs/api-reference/apps/get-app.md): Returns a single app by UUID or slug.
- [List Apps](https://docs.velahq.xyz/docs/api-reference/apps/list-apps.md): Returns all apps belonging to the authenticated account.
- [Rotate API Key](https://docs.velahq.xyz/docs/api-reference/apps/rotate-api-key.md): Generates a new API key for the app. The old key is **immediately revoked** — this action is irreversible.
- [Update App](https://docs.velahq.xyz/docs/api-reference/apps/update-app.md): Updates an app's name and/or slug.
- [Authentication](https://docs.velahq.xyz/docs/api-reference/authentication.md): How to authenticate with the Vela API — two credentials, two headers, and why they're separate.
- [Ingest Events](https://docs.velahq.xyz/docs/api-reference/events/ingest-events.md): Send one or more events to Vela. Events are validated against their registered schema. Supports single event or batch of up to 100.
- [List Events](https://docs.velahq.xyz/docs/api-reference/events/list-events.md): Returns paginated events for an app with optional filters.
- [API Reference](https://docs.velahq.xyz/docs/api-reference/introduction.md): Vela HTTP API — base URL, authentication, request format, error handling, and endpoint overview.
- [Create Notification Rule](https://docs.velahq.xyz/docs/api-reference/notification-rules/create-notification-rule.md): Creates a new notification rule.
- [List Notification Rules](https://docs.velahq.xyz/docs/api-reference/notification-rules/list-notification-rules.md): Returns all notification rules for an app.
- [Update Notification Rule](https://docs.velahq.xyz/docs/api-reference/notification-rules/update-notification-rule.md): Updates an existing notification rule. All fields are optional.
- [Create Schema](https://docs.velahq.xyz/docs/api-reference/schemas/create-schema.md): Registers a new event schema for the app.
- [Get Schema by Event Name](https://docs.velahq.xyz/docs/api-reference/schemas/get-schema-by-event-name.md): Returns a single schema by its event name.
- [List Schemas](https://docs.velahq.xyz/docs/api-reference/schemas/list-schemas.md): Returns all event schemas for an app.
- [Update Schema](https://docs.velahq.xyz/docs/api-reference/schemas/update-schema.md): Updates an existing event schema. All fields are optional. The `fields` array replaces existing fields entirely.
- [Configuration](https://docs.velahq.xyz/docs/cli/configuration.md): Configure the Vela CLI with a config file and environment variables.
- [vela diff](https://docs.velahq.xyz/docs/cli/diff.md): Preview schema changes before pushing — see exactly what would be created or updated without touching the remote API.
- [Installation](https://docs.velahq.xyz/docs/cli/installation.md): Install and configure the Vela CLI to manage schemas as code.
- [Vela CLI](https://docs.velahq.xyz/docs/cli/overview.md): Manage event schemas as code — define them in JSON files, preview changes, and push to Vela. Like Prisma migrations, but for your event types.
- [vela pull](https://docs.velahq.xyz/docs/cli/pull.md): Download remote schemas from the Vela API and write them as local JSON files.
- [vela push](https://docs.velahq.xyz/docs/cli/push.md): Sync local schema files to the remote Vela API — creates new schemas and updates changed ones.
- [Schema File Format](https://docs.velahq.xyz/docs/cli/schema-format.md): How to write JSON schema files for the Vela CLI — file naming, field definitions, types, and validation rules.
- [Core Concepts](https://docs.velahq.xyz/docs/concepts.md): Understand the Vela data model — apps, schemas, events, rules, and destinations
- [API Keys](https://docs.velahq.xyz/docs/credentials/api-keys.md): App-level credentials used exclusively for event ingestion. One active key per app, shown once at creation.
- [Client Secrets](https://docs.velahq.xyz/docs/credentials/client-secrets.md): Account-level credentials for the Vela Management API. Used to create apps, manage schemas, and configure notification rules.
- [Credentials Overview](https://docs.velahq.xyz/docs/credentials/overview.md): Vela uses two credentials — client secrets for management and API keys for ingestion. Here is how they differ and when to use each.
- [Introduction](https://docs.velahq.xyz/docs/index.md): Vela is an open-source event ingestion and notification platform. Send structured events from your backend, validate them against schemas, and get real-time alerts on Slack, Discord, Email, or webhooks.
- [Quickstart](https://docs.velahq.xyz/docs/quickstart.md): Send your first event to Vela in under 5 minutes
- [Apps](https://docs.velahq.xyz/docs/sdks/python/apps.md): Create and manage Vela apps with Python
- [Configuration](https://docs.velahq.xyz/docs/sdks/python/configuration.md): Configure base URL and timeout for the Python SDK
- [Error Handling](https://docs.velahq.xyz/docs/sdks/python/error-handling.md): Handle API errors in Python
- [Events (Read)](https://docs.velahq.xyz/docs/sdks/python/events.md): Query and paginate through ingested events with Python
- [Ingest Client](https://docs.velahq.xyz/docs/sdks/python/ingest-client.md): Send events to Vela with VelaIngestClient
- [Installation](https://docs.velahq.xyz/docs/sdks/python/installation.md): Install the vela-sdk package
- [Management Client](https://docs.velahq.xyz/docs/sdks/python/management-client.md): Manage apps, schemas, and notification rules
- [Notification Rules](https://docs.velahq.xyz/docs/sdks/python/notification-rules.md): Set up conditional event alerts with Python
- [Python SDK](https://docs.velahq.xyz/docs/sdks/python/overview.md): Official Python SDK for the Vela platform
- [Schemas](https://docs.velahq.xyz/docs/sdks/python/schemas.md): Define and manage event schemas with Python
- [Apps](https://docs.velahq.xyz/docs/sdks/typescript/apps.md): Create and manage Vela apps
- [Configuration](https://docs.velahq.xyz/docs/sdks/typescript/configuration.md): Configure base URL, timeout, and custom fetch
- [Error Handling](https://docs.velahq.xyz/docs/sdks/typescript/error-handling.md): Handle API errors with typed exceptions — catch specific error classes, inspect status codes, and distinguish transport errors from API errors.
- [Events (Read)](https://docs.velahq.xyz/docs/sdks/typescript/events.md): Query and paginate through ingested events
- [Ingest Client](https://docs.velahq.xyz/docs/sdks/typescript/ingest-client.md): Send single and batch events to Vela with VelaIngestClient — full API reference with examples.
- [Installation](https://docs.velahq.xyz/docs/sdks/typescript/installation.md): Install the @vela-event/sdk package, set up credentials, and verify your connection.
- [Management Client](https://docs.velahq.xyz/docs/sdks/typescript/management-client.md): Manage apps, schemas, notification rules, and API keys with VelaManagementClient — full method reference.
- [Notification Rules](https://docs.velahq.xyz/docs/sdks/typescript/notification-rules.md): Set up conditional event alerts
- [TypeScript SDK](https://docs.velahq.xyz/docs/sdks/typescript/overview.md): Official TypeScript/JavaScript SDK for the Vela platform — type-safe event ingestion and account management with zero runtime dependencies.
- [Schemas](https://docs.velahq.xyz/docs/sdks/typescript/schemas.md): Define and manage event schemas
- [TypeScript Types](https://docs.velahq.xyz/docs/sdks/typescript/types.md): All exported types from @vela/sdk
- [UI Walkthrough](https://docs.velahq.xyz/docs/ui-walkthrough.md): Step-by-step guide to setting up your first app, schemas, integrations, and notification rules in the Vela dashboard.

## OpenAPI Specs

- [openapi](https://docs.velahq.xyz/docs/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/Vela-Events/vela)
- [Dashboard](https://app.velahq.xyz)