[ QUICKSTART ]

Watching your app in five minutes

CanaryHub tells you how your software is doing without you opening a dashboard: business events like signups and payments, errors worth knowing about, and uptime — delivered to Telegram and SMS. This page gets your first event flowing.

1. Create an account and get an API key

Sign up (free), then open Dashboard → API keys and create a key. Keys look like ch_live_… and are shown once — we only store a hash, so copy it when you create it.

2. Send your first event

No install needed — the API is plain HTTPS, so this works from any language:

$ curl -X POST https://ingest.canaryhub.ai/api/v1/events \    -H "Authorization: Bearer ch_live_YOUR_KEY" \    -H "Content-Type: application/json" \    -d '{"events":[{"type":"event","name":"first-canary"}]}'{"accepted":1}

{"accepted":1} means the event is stored and on your dashboard.

3. Instrument your app (Node)

For JavaScript/TypeScript apps, the SDK batches events and never slows down or crashes your app:

$ npm install @canaryhub/sdk

import { canary } from "@canaryhub/sdk";canary.init("ch_live_YOUR_KEY"); // or set CANARY_API_KEY and call canary.init()// The two calls you'll actually use:canary.event("signup");canary.event("payment", { value: 29 });canary.error("stripe webhook failed", { message: err.message });

That's the whole integration. Business events are deliberate — add one line at signup, one at checkout, and you're done. See the SDK reference for batching and safety details, or the HTTP API for every other language.

4. What happens to your events

• Everything lands on your dashboard — counts, charts, and an event feed.
• Only curated things interrupt you. Errors go into a digest by default; business events roll up daily ("8 signups, $145 today"). Nothing pages you until you opt it in — no alert fatigue by design.
• Uptime pages instantly. Site-down and recovery alerts go straight to Telegram/SMS.