Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.velahq.xyz/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Sync client

from vela import VelaIngestClient

with VelaIngestClient("vela_live_xxx") as client:
    result = client.ingest({
        "event": "order.placed",
        "data": {"orderId": "ord_1", "amountCents": 4999},
        "level": "info",
    })
    print(result.accepted)  # 1

​
Async client

from vela import AsyncVelaIngestClient

async with AsyncVelaIngestClient("vela_live_xxx") as client:
    result = await client.ingest({
        "event": "order.placed",
        "data": {"orderId": "ord_1", "amountCents": 4999},
        "level": "info",
    })

​
Constructor

VelaIngestClient(
    api_key: str,
    *,
    base_url: str = "https://api.vela.dev",
    timeout: float = 30.0,
)

​
Single event

result = client.ingest({
    "event": "order.placed",       # required -- must match a registered schema
    "data": {                       # required -- event payload
        "orderId": "ord_abc123",
        "amountCents": 4999,
        "currency": "USD",
    },
    "level": "info",                # required
    "customer_id": "cust_42",       # optional
    "metadata": {"env": "prod"},    # optional
    "timestamp": "2024-06-01T12:00:00.000Z",  # optional
})

print(result.accepted)        # 1
print(result.events[0].id)    # UUID

​
Batch (up to 100 events)

result = client.ingest([
    {"event": "order.placed",   "data": {"orderId": "ord_1"}, "level": "info"},
    {"event": "order.placed",   "data": {"orderId": "ord_2"}, "level": "info"},
    {"event": "payment.failed", "data": {"orderId": "ord_3", "reason": "card_declined"}, "level": "error"},
])

print(result.accepted)  # 3

​
Event levels

LevelWhen to use
infoNormal business events — order placed, user signed up
successCompleted flows — payment captured, email delivered
warningDegraded but non-critical — retry #2, slow response
errorFailures requiring attention — payment failed, webhook error