Event Apps overview — Cliodot Documentation

Product model: Event Apps use event names and delivery profiles configured in the portal. Choose a profile for the outcome you need — fast, durable, and so on — and use the profile that fits the app.

Runtime client for Cliodot Event Apps. Lives in the cliodot package (cliodot-flosync).

Base path: /event
Auth: x-cliodot-app-id + Bearer eak_… API key, or app secret.

You work with event names and delivery profiles. Profiles are chosen in the portal for the outcome you need — for example fast delivery for live fan-out, or a more durable profile when you need stronger guarantees. Pick the profile that fits the app; the SDK only speaks events and profiles.

Install#

npm install cliodot

Configure#

import { Events } from "cliodot";

const events = new Events({
  baseUrl: "https://your-host",
  appId: process.env.EVENT_APP_ID!,
  apiKey: process.env.EVENT_APP_API_KEY!,
});

Or with app secret:

const events = new Events({
  baseUrl: "https://your-host",
  appId: "evt_app_…",
  appSecret: process.env.EVENT_APP_SECRET!,
});

appApiKey is accepted as an alias of apiKey.