TypeScript SDK

npm install @logstitch/sdk

import { LogStitch } from '@logstitch/sdk';

const logstitch = new LogStitch({
  projectKey: 'pk_your_key_here',
});

// Log an event (fire-and-forget by default)
logstitch.log({
  action: 'user.signed_up',
  category: 'auth',
  actor: { id: 'user_123', type: 'user', name: 'Alice' },
  tenant_id: 'acme_corp',
  metadata: { plan: 'pro' },
});

// Always close on shutdown to flush pending events
await logstitch.close();

logstitch.log({
  action: 'document.shared',
  category: 'documents',
  actor: { id: 'user_123', type: 'user', name: 'Alice' },
  tenant_id: 'acme_corp',
  target: { id: 'doc_456', type: 'document', name: 'Q4 Report' },
  metadata: { permission: 'view' },
});

const response = await logstitch.logBatch([
  {
    action: 'user.created',
    tenant_id: 'acme_corp',
    actor: { id: 'user_1', type: 'user' },
  },
  {
    action: 'user.created',
    tenant_id: 'acme_corp',
    actor: { id: 'user_2', type: 'user' },
  },
]);

// response.ids — array of created event IDs
// response.redacted_count — number of fields redacted by PII rules

await logstitch.flush();

// Graceful shutdown
process.on('SIGTERM', async () => {
  await logstitch.close();
  process.exit(0);
});

const { events, cursor } = await logstitch.events.list({
  tenant_id: 'acme_corp',
  action: 'user.created',
  limit: 25,
});

// Fetch next page
if (cursor) {
  const nextPage = await logstitch.events.list({
    tenant_id: 'acme_corp',
    cursor,
  });
}

const { token } = await logstitch.viewerTokens.create({
  tenant_id: 'acme_corp',
  expires_in: 3600,
});

// Pass the token to your frontend for use with <LogViewer />

const logstitch = new LogStitch({
  projectKey: 'pk_your_key_here',
  onError: (error) => {
    // Log to your observability stack
    console.error('LogStitch error:', error.message);
  },
});

// This will not throw even if the API is unreachable
logstitch.log({
  action: 'user.signed_up',
  tenant_id: 'acme_corp',
  actor: { id: 'user_123', type: 'user' },
});

import { LogStitch, LogStitchError } from '@logstitch/sdk';

const logstitch = new LogStitch({
  projectKey: 'pk_your_key_here',
  strict: true,
});

try {
  const response = await logstitch.logBatch([
    {
      action: 'invoice.paid',
      tenant_id: 'acme_corp',
      actor: { id: 'system', type: 'service' },
    },
  ]);
} catch (err) {
  if (err instanceof LogStitchError) {
    console.error(err.status);    // 429
    console.error(err.code);      // "daily_event_limit_reached"
    console.error(err.requestId); // "req_01HZ..."
  }
}

import { LogStitch } from '@logstitch/sdk';

// No API key needed — generates a claim token automatically
const stream = LogStitch.stream();

// Console prints: "LogStitch Stream Mode — Claim at: https://logstitch.io/claim?token=<uuid>"
console.log('Claim token:', stream.token);

// Log events exactly the same way
stream.log({
  action: 'user.signed_up',
  category: 'auth',
  actor: { id: 'user_123', type: 'user', name: 'Alice' },
  tenant_id: 'acme_corp',
});

await stream.close();