Quick start

Create a project, copy its key, and post your first event. About two minutes.

1. Create a project

Open the app, create an account, and name a project. A project is one product you track: it has its own feed, channels and keys.

The app shows the project’s first key once. Copy it. A key that gets lost can be replaced under Setup.

2. Post an event

curl -X POST https://api.snekot.co/v1/log \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "payments",
    "event": "New subscription",
    "description": "[email protected] upgraded to Pro",
    "icon": "💰",
    "notify": true,
    "tags": { "plan": "pro" },
    "user_id": "user-123"
  }'

It appears in the feed at once. Only channel and event are required.

  • channel groups events, such as payments or errors. A channel exists as soon as an event names it.
  • notify sends the event as a push notification to everyone on the project who has not muted that channel.
  • tags are yours to choose. Charts can rank by them, and search looks inside them.
  • user_id ties the event to a person, who then gets a page with everything they did.

3. Use an SDK instead

The same call from code, here in TypeScript:

npm install https://github.com/snekot-co/snekot-js/releases/download/0.2.0/snekot-sdk-0.2.0.tgz
import { Client } from '@snekot/sdk';

const events = new Client({ token: process.env.SNEKOT_TOKEN, project: 'acme-store' });

await events.track({
  channel: 'payments',
  event: 'New subscription',
  icon: '💰',
  notify: true,
  tags: { plan: 'pro' },
});

There are libraries for TypeScript, Effect, Rust, Swift, Kotlin and Python, all open source at github.com/snekot-co, and a script tag for web pages.

4. Look at it

  • Events shows events as they arrive. Tap one for everything it carries.
  • Charts is a board you build: bars, funnels, a year heatmap, goals and ranked lists.
  • Insights are single numbers your product sets, such as MRR. See Sending events.
  • People lists everyone your events mention.