ingestlayer/docs/v0.4

docs · 01 start

Quickstart.

Five minutes from pnpm add to an event landing in your dashboard. Below is the SDK path; if you can't install a package, scroll down for the curl one.

Install

One dependency.

npm · install + env↵ copy
# in your project
$ pnpm add @ingestlayer/sdk

# .env — get the key from /keys in the dashboard
INGESTLAYER_KEY=il_live_***

Bearer keys are minted at /keys inside the dashboard. A key is org-scoped and rotates without downtime.

Send

One call.

from your app · TypeScript↵ copy
// anywhere in your app
import { ingest } from "@ingestlayer/sdk";

await ingest("user.signup", {
  email:  user.email,
  plan:   user.intendedPlan,
  source: "marketing-site",
});

The first argument is the event type (any string you control — user.signup, order.placed, etc.). The second is the payload object — anything JSON-serializable.

No SDK? Same thing via HTTP:

from any host · curl↵ copy
# no SDK, no problem
$ curl -X POST https://in.ingestlayer.com/v1/ingest \
    -H "Authorization: Bearer $INGESTLAYER_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "events": [{
        "type":    "user.signup",
        "payload": { "email": "ada@example.com", "plan": "pro" }
      }]
    }'

See it

The events stream.

Open /events in the dashboard. New events appear at the top within a second; clicking one shows its payload, source, and any deliveries that fanned out from it.

At this point you have ingestion, durability, and a typed history. Next: do something with the events.


back to docsnext: build a pipeline