Docsv1.0
Docs/Getting Started/Quickstart

Quickstart

Get your first tip event in under 2 minutes.

Get a live tip event streaming to your terminal in three steps.

1. Create an API Token

Open Settings → API Tokens in your Tizemint dashboard and create a new token. Copy the token immediately — it is shown only once.

Warning
Store your token somewhere safe. Tizemint hashes tokens on the server and cannot recover them after creation.

Your token looks like this:

tzmnt_a1b2c3d4e5f6...

2. Connect with curl

Replace YOUR_TOKEN with the token you just copied:

bash
curl -N "https://tizemint.com/api/tip-events/stream?token=YOUR_TOKEN"

You can also authenticate via the Authorization header:

bash
curl -N -H "Authorization: Bearer YOUR_TOKEN" \
  "https://tizemint.com/api/tip-events/stream"

On a successful connection you will see:

data: {"type":"connected"}

The stream stays open. When a tip comes in, you will see:

data: {"type":"tip:received","tipId":"abc123","amount":500,"displayName":"Jamie","message":"Great stream!","isAnonymous":false,"goalId":null,"goalProgress":null,"goalTarget":null,"timestamp":"2026-04-07T18:30:00.000Z"}

3. Connect to the stream

Use the browser-native EventSource API — no dependencies required:

js
const url = "https://tizemint.com/api/tip-events/stream?token=YOUR_TOKEN";
const source = new EventSource(url);
 
source.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log(data.type, data);
};
 
source.onerror = () => {
  console.error("Connection lost — EventSource will auto-reconnect.");
};
Info
EventSource automatically reconnects if the connection drops. See SSE Endpoint for details on connection lifecycle.

Next Steps