Skip to main content
POST
/
ingest
curl --request POST \
  --url https://api.vela.dev/v1/ingest \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "event": "order.placed",
  "data": {
    "orderId": "ord_abc123",
    "amountCents": 4999
  },
  "level": "info",
  "customer_id": "cust_42",
  "metadata": {
    "env": "production"
  }
}
'
{
  "accepted": 2,
  "events": [
    {
      "id": "evt-uuid-1",
      "appId": "app-uuid",
      "event": "order.placed",
      "customer_id": null,
      "data": {
        "orderId": "ord_1"
      },
      "level": "info",
      "metadata": {},
      "timestamp": "2024-06-01T12:00:00.000Z",
      "ingestedAt": "2024-06-01T12:00:00.123Z"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for event ingestion. Format: vela_live_...

Body

application/json
​
event
string
required

Event name (must match a registered schema)

​
data
object
required

Event payload (validated against schema)

​
level
enum<string>
required

Event severity level

Available options:
info,
warning,
error,
success
​
customer_id
string

Customer identifier

​
metadata
object

Contextual data (validated against metadata fields)

​
timestamp
string<date-time>

ISO-8601 timestamp (defaults to now)

Response

201 - application/json

Events accepted

​
accepted
integer

Number of events accepted

​
events
object[]