Quickstart

import { EmitKit } from '@emitkit/js';

const client = new EmitKit('your_api_key');

// Get alerted when a user signs up
await client.events.create({
  channelName: 'signups',
  title: 'New user signed up',
  userId: 'user_123',
  metadata: {
    email: 'user@example.com',
    source: 'google',
    plan: 'free'
  }
});

// Send a notification
await client.events.create({
  channelName: 'alerts',
  title: 'Payment Failed',
  description: 'Credit card declined',
  icon: '⚠️',
  notify: true
});

await client.events.create({
  channelName: 'payments',
  title: 'Payment Received',
  description: 'User upgraded to Pro plan',
  icon: '💰',
  userId: 'user_123',
  tags: ['payment', 'upgrade'],
  metadata: {
    amount: 99.99,
    currency: 'USD',
    plan: 'pro',
    transactionId: 'txn_abc123'
  }
});

// Create user identity with aliases
await client.identify({
  user_id: 'user_123',
  properties: {
    email: 'john@example.com',
    name: 'John Doe',
    plan: 'pro',
    signupDate: '2025-01-15'
  },
  aliases: [
    'john@example.com',  // Email
    'johndoe',            // Username
    'ext_12345'           // External system ID
  ]
});

// Now you can reference the user by any alias
await client.events.create({
  channelName: 'activity',
  title: 'User logged in',
  userId: 'john@example.com',  // ← Alias works!
});

const client = new EmitKit('your_api_key', {
  // Custom base URL (for self-hosted instances)
  baseUrl: 'https://api.your-domain.com',

  // Request timeout in milliseconds
  timeout: 30000,

  // Custom fetch implementation (optional)
  fetch: customFetch
});